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

# show deployment

> Returns detailed information about a single deployment, including endpoint state and worker count.

CLI Usage: `vastai show deployment <id>`



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/v0/deployment/{id}/
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/deployment/{id}/:
    get:
      tags:
        - Serverless
      summary: show deployment
      description: >-
        Returns detailed information about a single deployment, including
        endpoint state and worker count.


        CLI Usage: `vastai show deployment <id>`
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: Deployment ID
          example: 644
      responses:
        '200':
          description: Deployment details
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  deployment:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 644
                      name:
                        type: string
                        example: square
                      tag:
                        type: string
                        example: default
                      image:
                        type: string
                        example: vastai/base-image:latest
                      endpoint_id:
                        type: integer
                        nullable: true
                        example: 25121
                      endpoint_state:
                        type: string
                        nullable: true
                        description: Current state of the endpoint
                        example: active
                      env:
                        type: string
                        nullable: true
                        description: Environment variables and port mappings
                      s3_key:
                        type: string
                        nullable: true
                        description: S3 object key for the current code version
                      file_hash:
                        type: string
                        nullable: true
                        description: Content hash of the deployed code
                      search_params:
                        type: string
                        nullable: true
                        description: Search query for instance selection
                      current_version_id:
                        type: integer
                        nullable: true
                      last_healthy_version_id:
                        type: integer
                        nullable: true
                      storage:
                        type: number
                        example: 16
                      ttl:
                        type: number
                        nullable: true
                      last_client_heartbeat:
                        type: number
                        nullable: true
                        description: Unix timestamp of last client heartbeat
                      created_at:
                        type: number
                        description: Unix timestamp
                      updated_at:
                        type: number
                        description: Unix timestamp
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Deployment not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    example: API requests too frequent endpoint threshold=3.0
      security:
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        msg:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````