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

# Put the sandbox in standby

> Asks the host to put the sandbox in standby right away instead of waiting for it to be idle.
Returns 202 before the standby happens; the connection is closed and the sandbox pauses shortly after.
Refused while a keepAlive process or an archive operation holds the sandbox awake, unless force is true.



## OpenAPI

````yaml https://raw.githubusercontent.com/blaxel-ai/sandbox/refs/heads/main/sandbox-api/docs/openapi.yml post /standby
openapi: 3.0.0
info:
  contact: {}
  description: API for manipulating filesystem, processes and network.
  title: Sandbox API
  version: 0.0.1
servers:
  - url: https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run
    variables:
      sandbox_id:
        default: unknown
      workspace_id:
        default: unknown
      region:
        default: unknown
security:
  - BearerAuth: []
paths:
  /standby:
    post:
      tags:
        - system
      summary: Put the sandbox in standby
      description: >-
        Asks the host to put the sandbox in standby right away instead of
        waiting for it to be idle.

        Returns 202 before the standby happens; the connection is closed and the
        sandbox pauses shortly after.

        Refused while a keepAlive process or an archive operation holds the
        sandbox awake, unless force is true.
      parameters:
        - description: >-
            Put the sandbox in standby even while keepAlive processes hold it
            awake: their holds are released for the standby and taken back once
            it resumes
          in: query
          name: force
          schema:
            type: boolean
      responses:
        '202':
          description: Standby requested
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '409':
          description: The sandbox is held awake
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '501':
          description: Standby is not supported in this environment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The keep-awake state could not be read
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SuccessResponse:
      properties:
        message:
          example: File created successfully
          type: string
        path:
          example: /path/to/file
          type: string
      required:
        - message
      type: object
    ErrorResponse:
      properties:
        code:
          example: FILE_ALREADY_EXISTS
          type: string
        error:
          example: Error message
          type: string
      required:
        - error
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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