Paperspace Deployments API

Container-as-a-service deployments that run user-provided images on Paperspace GPU machines with a managed endpoint, autoscaling, rolling updates, runs, metrics, logs, and revision history. Includes the project-scoped deployment listing.

Operations 9

GET /deployments List Deployments #
POST /deployments Create or Update Deployment #
GET /deployments/{id} Get Deployment #
DELETE /deployments/{id} Delete Deployment #
GET /deployments/{id}/runs List Deployment Runs #
GET /deployments/{id}/metrics Get Deployment Metrics #
GET /deployments/{id}/logs Get Deployment Logs #
GET /deployments/{id}/history Get Deployment History #
GET /projects/{id}/deployments List Project Deployments #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/paperspace-deployments-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

paperspace-deployments-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Paperspace Container Registries Activity Deployments 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: Deployments
  description: Container-based deployment lifecycle.
paths:
  /deployments:
    get:
      tags:
      - Deployments
      operationId: listDeployments
      summary: List Deployments
      description: Fetches a list of deployments for the authenticated team.
      parameters:
      - $ref: '#/components/parameters/After'
      - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: A page of deployments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentList'
    post:
      tags:
      - Deployments
      operationId: upsertDeployment
      summary: Create or Update Deployment
      description: Submits a new deployment configuration. If the deployment does not exist one is created; otherwise a new run is started against the existing deployment.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentSpec'
      responses:
        '200':
          description: Upserted deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
  /deployments/{id}:
    parameters:
    - $ref: '#/components/parameters/DeploymentId'
    get:
      tags:
      - Deployments
      operationId: getDeployment
      summary: Get Deployment
      description: Fetches a single deployment by deployment ID.
      responses:
        '200':
          description: Deployment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Deployment'
    delete:
      tags:
      - Deployments
      operationId: deleteDeployment
      summary: Delete Deployment
      description: Removes a deployment using its identifier.
      responses:
        '204':
          description: Deleted.
  /deployments/{id}/runs:
    parameters:
    - $ref: '#/components/parameters/DeploymentId'
    get:
      tags:
      - Deployments
      operationId: listDeploymentRuns
      summary: List Deployment Runs
      description: Lists the active deployment runs for a deployment.
      responses:
        '200':
          description: Run list.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentRun'
  /deployments/{id}/metrics:
    parameters:
    - $ref: '#/components/parameters/DeploymentId'
    get:
      tags:
      - Deployments
      operationId: getDeploymentMetrics
      summary: Get Deployment Metrics
      description: Retrieves performance data for a given deployment over a time range.
      parameters:
      - in: query
        name: start
        schema:
          type: string
          format: date-time
      - in: query
        name: end
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Metrics response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentMetrics'
  /deployments/{id}/logs:
    parameters:
    - $ref: '#/components/parameters/DeploymentId'
    get:
      tags:
      - Deployments
      operationId: getDeploymentLogs
      summary: Get Deployment Logs
      description: Obtains log entries associated with a deployment.
      parameters:
      - in: query
        name: limit
        schema:
          type: integer
      responses:
        '200':
          description: Log stream.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LogLine'
  /deployments/{id}/history:
    parameters:
    - $ref: '#/components/parameters/DeploymentId'
    get:
      tags:
      - Deployments
      operationId: getDeploymentHistory
      summary: Get Deployment History
      description: Accesses configuration change records for a deployment.
      responses:
        '200':
          description: History records.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DeploymentRevision'
  /projects/{id}/deployments:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Deployments
      operationId: listProjectDeployments
      summary: List Project Deployments
      description: Fetches a list of deployments scoped to a specific project.
      responses:
        '200':
          description: Deployment list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentList'
components:
  schemas:
    DeploymentList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Deployment'
        hasMore:
          type: boolean
        nextPage:
          type: string
    LogLine:
      type: object
      properties:
        t:
          type: string
          format: date-time
        stream:
          type: string
          enum:
          - stdout
          - stderr
        message:
          type: string
    AutoscalingPolicy:
      type: object
      properties:
        min:
          type: integer
        max:
          type: integer
        target:
          type: integer
        metric:
          type: string
          enum:
          - cpu
          - memory
          - requests
    DeploymentSpec:
      type: object
      required:
      - name
      - image
      - machineType
      properties:
        name:
          type: string
        projectId:
          type: string
        image:
          type: string
        machineType:
          type: string
        replicas:
          type: integer
        ports:
          type: array
          items:
            type: integer
        env:
          type: object
          additionalProperties:
            type: string
        command:
          type: array
          items:
            type: string
        autoscaling:
          $ref: '#/components/schemas/AutoscalingPolicy'
    DeploymentRevision:
      type: object
      properties:
        revision:
          type: integer
        spec:
          $ref: '#/components/schemas/DeploymentSpec'
        dtCreated:
          type: string
          format: date-time
        userId:
          type: string
    DeploymentRun:
      type: object
      properties:
        id:
          type: string
        deploymentId:
          type: string
        state:
          type: string
        replicas:
          type: integer
        dtStarted:
          type: string
          format: date-time
    Deployment:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        image:
          type: string
        projectId:
          type: string
        machineType:
          type: string
        clusterId:
          type: string
        endpoint:
          type: string
        replicas:
          type: integer
        state:
          type: string
          enum:
          - ready
          - scaling
          - deploying
          - error
          - stopped
        autoscaling:
          $ref: '#/components/schemas/AutoscalingPolicy'
        dtCreated:
          type: string
          format: date-time
    DeploymentMetrics:
      type: object
      properties:
        deploymentId:
          type: string
        series:
          type: array
          items:
            type: object
            properties:
              metric:
                type: string
              values:
                type: array
                items:
                  type: object
                  properties:
                    t:
                      type: string
                      format: date-time
                    v:
                      type: number
  parameters:
    After:
      in: query
      name: after
      schema:
        type: string
    Limit:
      in: query
      name: limit
      schema:
        type: integer
    DeploymentId:
      in: path
      name: id
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: api-key