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

# Cleanup Machine Expired Contracts

> Sends a volume cleanup task to the machine daemon and soft-deletes expired client contracts on the machine.



## OpenAPI

````yaml /api-reference/openapi.yaml put /api/v0/machines/{machine_id}/cleanup
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
  license:
    name: Vast.ai Terms of Service
    url: https://vast.ai/terms/
servers:
  - url: https://console.vast.ai
    description: Production server
security:
  - BearerAuth: []
paths:
  /api/v0/machines/{machine_id}/cleanup:
    put:
      tags:
        - Machines
      summary: Cleanup Machine Expired Contracts
      description: >-
        Sends a volume cleanup task to the machine daemon and soft-deletes
        expired client contracts on the machine.
      operationId: cleanupMachineExpiredContracts
      parameters:
        - name: machine_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the machine on which expired contracts should be cleaned up.
      responses:
        '200':
          description: >-
            Returns {success: true, ctime, machine_id, user_id, num_deleted,
            msg} when contracts were deleted; {success: false, msg: "No expired
            contracts to delete"} when nothing to clean
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether any contracts were deleted
                  ctime:
                    type: number
                    description: Unix timestamp when cleanup ran
                  machine_id:
                    type: integer
                    description: ID of the cleaned machine
                  user_id:
                    type: integer
                    description: ID of the authenticated user
                  num_deleted:
                    type: integer
                    description: Number of expired contracts removed
                  msg:
                    type: string
                    description: Human-readable summary of the operation
              example:
                success: true
                ctime: 1718000000
                machine_id: 12345
                user_id: 9876
                num_deleted: 5
                msg: deleted 5 expired contracts on machine 12345
        '400':
          description: '"Invalid machine_id" if machine_id is None'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '"error: only the owner can access this machine."'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '"No such machine id" when the machine does not exist'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        msg:
          type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key must be provided in the Authorization header

````