Paperspace Machine Types API

Region/availability lookups for machine types.

OpenAPI Specification

paperspace-machine-types-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Paperspace Container Registries Activity Machine Types API
  version: v1
  description: 'Manage container registry credentials used by Paperspace Deployments to

    pull private images. Authenticate with a team-scoped API key as

    `Authorization: Bearer $API_TOKEN`.

    '
servers:
- url: https://api.paperspace.com/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Machine Types
  description: Region/availability lookups for machine types.
paths:
  /machine-availability:
    get:
      tags:
      - Machine Types
      operationId: getMachineAvailability
      summary: Get Machine Availability
      description: Gets the machine availability for a given region and machine type.
      parameters:
      - in: query
        name: machineType
        required: true
        schema:
          type: string
      - in: query
        name: region
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Availability response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  available:
                    type: boolean
                  machineType:
                    type: string
                  region:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: api-key