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

# Set pause when idle

> Pause the sandbox after this many minutes with no traffic, sessions or envd processes. 0 turns it off.



## OpenAPI

````yaml /compute/api-reference/anona-openapi.yaml put /v1/sandboxes/{sandboxID}/auto-pause
openapi: 3.0.3
info:
  title: Anona Compute API (Anona routes)
  version: 0.1.0
  description: >
    Routes the Anona Compute gateway serves next to the E2B-compatible API:

    live-view viewer tokens, SSH certificates, network policy, the credential

    vault, usage and billing, webhooks and telemetry export, thumbnails, preview
    links,

    public ports, pause when idle, template builds, and API key management.


    Written from the gateway handlers
    (`gateway/internal/stream/token/handlers.go`,

    `gateway/internal/sshca/handler.go`,
    `gateway/internal/handlers/apikeys/apikeys.go`)

    and checked against a running gateway by
    `docs-site/scripts/verify_openapi.py`.
servers:
  - url: https://api.compute.anonalabs.com
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Live view
  - name: SSH
  - name: Sandbox access
  - name: Templates
  - name: Network
  - name: Credential vault
  - name: Usage and billing
  - name: Webhooks and telemetry
  - name: API keys
  - name: Service
paths:
  /v1/sandboxes/{sandboxID}/auto-pause:
    put:
      tags:
        - Sandbox access
      summary: Set pause when idle
      description: >-
        Pause the sandbox after this many minutes with no traffic, sessions or
        envd processes. 0 turns it off.
      operationId: setIdlePause
      parameters:
        - $ref: '#/components/parameters/sandboxID'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - idleMinutes
              properties:
                idleMinutes:
                  type: integer
                  minimum: 0
                  maximum: 10080
      responses:
        '200':
          description: The sandbox's access settings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxAccess'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    sandboxID:
      name: sandboxID
      in: path
      required: true
      schema:
        type: string
  schemas:
    SandboxAccess:
      type: object
      required:
        - sandboxID
        - allowPublicTraffic
        - publicPorts
        - idlePauseMinutes
      properties:
        sandboxID:
          type: string
        allowPublicTraffic:
          type: boolean
        publicPorts:
          type: array
          items:
            type: integer
          nullable: true
        idlePauseMinutes:
          type: integer
          description: '0: off'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          description: The HTTP status code.
        message:
          type: string
        error_code:
          type: string
          description: >-
            Machine-readable reason, on some errors (for example
            `invalid_request`).
  responses:
    BadRequest:
      description: The request body is invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: >-
        Not found, or not yours (the answer is the same, so IDs cannot be
        probed).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: An Anona Compute API key (`e2b_` followed by lowercase hex).
    BearerAuth:
      type: http
      scheme: bearer
      description: 'The same API key, sent as `Authorization: Bearer e2b_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.