> ## Documentation Index
> Fetch the complete documentation index at: https://vastai-80aa3a82-auto-openapi-update-79df5d46.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List Deployments

> Returns all active deployments for the authenticated user with their configuration and current version info.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v0/deployments/
openapi: 3.1.0
info:
  title: Vast.ai API
  description: >-
    Vast.ai REST API for managing GPU cloud instances, machine operations, and
    AI/ML workflows.


    ## AI Agent Quick-Start


    Install the CLI skill for your agent (Claude Code, Cursor, Windsurf, etc.):
      npx skills add vast-ai/vast-cli

    CLI reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai/SKILL.md

    SDK reference:
    https://raw.githubusercontent.com/vast-ai/vast-cli/master/vastai_sdk/SKILL.md


    ## Auth

    All endpoints require `Authorization: Bearer $VAST_API_KEY`.

    Get your key at: https://cloud.vast.ai/manage-keys/


    ## Key Quirks

    - `gpu_ram` in CLI = GB; in REST API = MB (CLI auto-converts)

    - SSH keys must be registered BEFORE creating an instance (VM: no recovery;
    Docker: can add post-create)

    - `onstart` field is limited to 4048 characters -- gzip+base64 for longer
    scripts

    - `POST /api/v0/asks/{id}/` (create instance) returns `new_contract` as the
    instance ID, not `id`

    - Poll trap: if `actual_status` becomes `exited`, `unknown`, or `offline` it
    will never reach `running` -- destroy and retry
  version: 1.0.0
  contact:
    name: Vast.ai Support
    url: https://discord.gg/vast
servers:
  - url: https://console.vast.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/v0/deployments/:
    get:
      tags:
        - Serverless
      summary: List Deployments
      description: >-
        Returns all active deployments for the authenticated user with their
        configuration and current version info.
      responses:
        '200':
          description: >-
            Returns {success: true, deployments: [{id, name, tag, endpoint_id,
            s3_key, env, image, storage, file_hash, search_params,
            current_version_id, last_healthy_version_id, ttl,
            last_client_heartbeat, created_at, updated_at}, ...]}
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always true on success.
                  deployments:
                    type: array
                    description: List of deployment objects.
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: Deployment ID.
                        name:
                          type: string
                          description: Deployment name.
                        tag:
                          type: string
                          description: Deployment tag (e.g. default).
                        endpoint_id:
                          type: integer
                          description: ID of the associated endpoint.
                        s3_key:
                          type: string
                          description: S3 key of the current deployment blob.
                        env:
                          type: string
                          description: Environment variable string for workers.
                        image:
                          type: string
                          description: Docker image for workers.
                        storage:
                          type: number
                          description: Disk storage size in GB.
                        file_hash:
                          type: string
                          description: Hash of the current deployment blob.
                        search_params:
                          type: string
                          description: Machine search filter string.
                        current_version_id:
                          type: integer
                          description: ID of the currently active version.
                        last_healthy_version_id:
                          type: integer
                          description: ID of the last known-good version.
                        ttl:
                          type: number
                          description: >-
                            Time-to-live in seconds after last heartbeat; null
                            means no auto-expiry.
                        last_client_heartbeat:
                          type: number
                          description: Unix timestamp of last client heartbeat.
                        created_at:
                          type: number
                          description: Unix timestamp of creation.
                        updated_at:
                          type: number
                          description: Unix timestamp of last update.
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````