> ## Documentation Index
> Fetch the complete documentation index at: https://docs.primeintellect.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pause Sandbox Endpoint

> Pause a running VM sandbox, keeping its memory and disk on its node.

Returns once the request is accepted. The status becomes PAUSED when the
pause completes; a failed pause leaves it RUNNING with an error message.

The pause's checkpoint then uploads its disk and memory in the background.
Deleting the sandbox before that upload finishes discards the checkpoint:
it can no longer be resumed, forked, or restored. Once the checkpoint is
stored (DURABLE), deleting the sandbox keeps it.

## Rate Limit

60 requests per 60 seconds per token per sandbox, and 30,000 per 60 seconds per IP.


## OpenAPI

````yaml https://api.primeintellect.ai/api/v1/sandbox/openapi.json post /api/v1/sandbox/{sandbox_id}/pause
openapi: 3.1.0
info:
  title: PI API
  version: 0.1.0
servers:
  - url: https://api.primeintellect.ai
security: []
paths:
  /api/v1/sandbox/{sandbox_id}/pause:
    post:
      tags:
        - Sandbox
      summary: Pause Sandbox Endpoint
      description: >-
        Pause a running VM sandbox, keeping its memory and disk on its node.


        Returns once the request is accepted. The status becomes PAUSED when the

        pause completes; a failed pause leaves it RUNNING with an error message.


        The pause's checkpoint then uploads its disk and memory in the
        background.

        Deleting the sandbox before that upload finishes discards the
        checkpoint:

        it can no longer be resumed, forked, or restored. Once the checkpoint is

        stored (DURABLE), deleting the sandbox keeps it.
      operationId: pause_sandbox_endpoint_api_v1_sandbox__sandbox_id__pause_post
      parameters:
        - name: sandbox_id
          in: path
          required: true
          schema:
            type: string
            title: Sandbox Id
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PauseSandboxResponse'
        '401':
          description: Authorization failed
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    PauseSandboxResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        dockerImage:
          type: string
          title: Dockerimage
        startCommand:
          anyOf:
            - $ref: '#/components/schemas/StartCommand'
            - type: string
            - type: 'null'
          title: Startcommand
        cpuCores:
          type: number
          title: Cpucores
        memoryGB:
          type: number
          title: Memorygb
        diskSizeGB:
          type: number
          title: Disksizegb
        diskMountPath:
          type: string
          title: Diskmountpath
        gpuCount:
          type: integer
          title: Gpucount
        gpuType:
          anyOf:
            - $ref: '#/components/schemas/GPUType'
            - type: 'null'
        vm:
          type: boolean
          title: Vm
          default: false
        network_allowlist:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Network Allowlist
        network_denylist:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Network Denylist
        status:
          $ref: '#/components/schemas/SandboxStatus'
        timeoutMinutes:
          type: integer
          title: Timeoutminutes
        idleTimeoutMinutes:
          anyOf:
            - type: integer
            - type: 'null'
          title: Idletimeoutminutes
        terminationReason:
          anyOf:
            - type: string
            - type: 'null'
          title: Terminationreason
        environmentVars:
          anyOf:
            - type: object
            - type: 'null'
          title: Environmentvars
        advancedConfigs:
          anyOf:
            - type: object
            - type: 'null'
          title: Advancedconfigs
        labels:
          items:
            type: string
          type: array
          title: Labels
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
        startedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Startedat
        terminatedAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Terminatedat
        exitCode:
          anyOf:
            - type: integer
            - type: 'null'
          title: Exitcode
        errorType:
          anyOf:
            - type: string
            - type: 'null'
          title: Errortype
        errorMessage:
          anyOf:
            - type: string
            - type: 'null'
          title: Errormessage
        userId:
          anyOf:
            - type: string
            - type: 'null'
          title: Userid
        teamId:
          anyOf:
            - type: string
            - type: 'null'
          title: Teamid
        kubernetesJobId:
          anyOf:
            - type: string
            - type: 'null'
          title: Kubernetesjobid
        registryCredentialsId:
          anyOf:
            - type: string
            - type: 'null'
          title: Registrycredentialsid
        pendingImageBuildId:
          anyOf:
            - type: string
            - type: 'null'
          title: Pendingimagebuildid
          description: >-
            Set while the sandbox is PENDING because its VM image artifact is
            being built automatically (first VM use of this image). The sandbox
            starts on its own once the build completes.
        gatewayAuth:
          anyOf:
            - $ref: '#/components/schemas/SandboxAuthResponse'
            - type: 'null'
          description: >-
            Gateway credentials, returned on create when the API token has
            sandbox:read. Same payload as POST /sandbox/{id}/auth.
        checkpointId:
          type: string
          title: Checkpointid
          description: >-
            The checkpoint the pause froze, with the sandbox's memory. POST
            /sandbox/{id}/resume continues this sandbox; creating a sandbox with
            this checkpoint_id and restore_memory=true forks it. Deleting the
            sandbox before this checkpoint is stored (DURABLE) discards it.
      type: object
      required:
        - id
        - name
        - dockerImage
        - startCommand
        - cpuCores
        - memoryGB
        - diskSizeGB
        - diskMountPath
        - gpuCount
        - status
        - timeoutMinutes
        - environmentVars
        - advancedConfigs
        - createdAt
        - updatedAt
        - startedAt
        - terminatedAt
        - userId
        - teamId
        - kubernetesJobId
        - checkpointId
      title: PauseSandboxResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    StartCommand:
      properties:
        executable:
          type: string
          minLength: 1
          title: Executable
        args:
          items:
            type: string
          type: array
          title: Args
      additionalProperties: false
      type: object
      required:
        - executable
      title: StartCommand
      description: A process to start without invoking a shell.
    GPUType:
      type: string
      enum:
        - CPU_NODE
        - A10_24GB
        - A100_80GB
        - A100_40GB
        - A30_24GB
        - A40_48GB
        - B200_180GB
        - B300_262GB
        - GB200
        - GB300
        - RTX3070_8GB
        - RTX3070_8GB
        - RTX3080_10GB
        - RTX3080Ti_12GB
        - RTX3090_24GB
        - RTX3090Ti_24GB
        - RTX4070Ti_12GB
        - RTX4080_16GB
        - RTX4080Ti_16GB
        - RTX4090_24GB
        - RTX5090_32GB
        - H100_80GB
        - H200_96GB
        - GH200_96GB
        - H200_141GB
        - GH200_480GB
        - GH200_624GB
        - L4_24GB
        - L40_48GB
        - L40S_48GB
        - RTX4000_8GB
        - RTX5000_16GB
        - RTX6000_24GB
        - RTX8000_48GB
        - RTX2000Ada_16GB
        - RTX4000Ada_20GB
        - RTX5000Ada_32GB
        - RTX6000Ada_48GB
        - A2000_6GB
        - A4000_16GB
        - A4500_20GB
        - A5000_24GB
        - A6000_48GB
        - V100_16GB
        - V100_32GB
        - P100_16GB
        - T4_16GB
        - P4_8GB
        - P40_24GB
        - RTX_PRO_6000B_96GB
        - MI355X_288GB
      title: GPUType
    SandboxStatus:
      type: string
      enum:
        - PENDING
        - PROVISIONING
        - RUNNING
        - PAUSED
        - ERROR
        - TERMINATED
        - TIMEOUT
      title: SandboxStatus
    SandboxAuthResponse:
      properties:
        token:
          type: string
          title: Token
          description: JWT token for direct sandbox access
        gateway_url:
          type: string
          title: Gateway Url
          description: Gateway URL for direct sandbox operations
        user_ns:
          type: string
          title: User Ns
          description: User namespace for sandbox access
        job_id:
          type: string
          title: Job Id
          description: Job ID for sandbox access
        expires_at:
          type: string
          format: date-time
          title: Expires At
          description: Token expiration time
      type: object
      required:
        - token
        - gateway_url
        - user_ns
        - job_id
        - expires_at
      title: SandboxAuthResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````