> ## Documentation Index > Fetch the complete documentation index at: https://docs.gmicloud.ai/llms.txt > Use this file to discover all available pages before exploring further. # Pause a sandbox > Pauses a running sandbox, preserving its ID, disk, memory, and process state. Resume continues the saved processes without re-running the template startup command. Only a running instance can be paused; any other state returns 409. Acceptance returns **202**. The `state` in the response is the state on the row at submission time — always `pausing` for a pause — and is **not** the final outcome; poll `GET /sandboxes/{id}` until it reports `paused`. A pause does not consume runtime: `end_at` is frozen while paused (so it may already be in the past) and is shifted forward by the paused duration on resume. A paused instance is instead bounded by the retention window `paused_expire_at`, after which the instance and its disk are both reclaimed. ## OpenAPI ````yaml /api-spec/sandbox_api.yaml post /sandboxes/{id}/pause openapi: 3.0.3 info: title: GMI Sandbox API description: >- REST API for GMI Sandbox: create isolated execution environments from templates or durable snapshots, manage their lifecycle on the control plane, and run commands or transfer files through each sandbox's own data plane. contact: name: GMI Cloud Support email: support@gmicloud.ai version: '2.0' servers: - url: https://console.gmicloud.ai/api/v2 description: Control plane security: - bearerAuth: [] tags: - name: Sandbox description: | Sandbox instance lifecycle management (Sandbox v2, /api/v2/sandboxes) - name: SandboxSnapshot description: Durable sandbox snapshot management (Sandbox v2, `/api/v2/snapshots`) - name: SandboxTemplate description: Sandbox template management (Sandbox v2, `/api/v2/templates`) - name: Sandbox-Exec description: > Sandbox execution data plane (accessed via the sandbox host and sandbox access token). These endpoints are not under the control plane's `/api/v2` path; clients connect directly to `https://{sandbox_key}.{domain}` and authenticate with `X-Access-Token`. - name: Sandbox-Shell description: > Sandbox interactive terminal (PTY) data plane. **These endpoints are not under `/api/v2`**: clients connect directly to `https://{sandbox_key}.{domain}` and authenticate with `X-Access-Token`. `{sandbox_key}`, `{domain}` and the `X-Access-Token` value are the `sandbox_key`, `domain` and `sandbox_access_token` returned by the control-plane create/connect endpoints; no extra endpoint is needed. Each sandbox has exactly **one logical shell session** and at most **one active WebSocket connection** at a time (a second concurrent attach is refused at handshake with `409`). Disconnecting does not destroy the shell — re-attaching resumes the same session; only `POST /shell/control` with `action=close` destroys it. - name: Sandbox-Files description: > Sandbox file data plane (`/files`). **These endpoints are not under `/api/v2`** and do not use `Authorization: Bearer`: they are served by the sandbox's own data-plane entry point — clients connect directly to `https://{sandbox_key}.{domain}` and authenticate with `X-Access-Token`. `{sandbox_key}` is the `sandbox_key` returned by the create/connect endpoints, used for data-plane host addressing. `{domain}` and `X-Access-Token` are the `domain` and `sandbox_access_token` from the same responses — no extra endpoint is needed to obtain them. This split is not historical baggage but the nature of a data plane: file transfer is long-lived, high-volume, and addressed per sandbox, differing from the control plane's short requests in both capacity model and failure domain, so they do not share an entry point. **One unified abstraction.** The same contract is served by two backend kinds (an in-sandbox file service / a data-center data-plane proxy); clients need not — and cannot — tell them apart. The cost is that the contract is their intersection: `Content-Length` on download and resumable download (`Range`/`206`) are **optional capabilities** that vary by data center, and clients must work correctly when they are absent. See the per-operation notes below. paths: /sandboxes/{id}/pause: post: tags: - Sandbox summary: Pause a sandbox description: > Pauses a running sandbox, preserving its ID, disk, memory, and process state. Resume continues the saved processes without re-running the template startup command. Only a running instance can be paused; any other state returns 409. Acceptance returns **202**. The `state` in the response is the state on the row at submission time — always `pausing` for a pause — and is **not** the final outcome; poll `GET /sandboxes/{id}` until it reports `paused`. A pause does not consume runtime: `end_at` is frozen while paused (so it may already be in the past) and is shifted forward by the paused duration on resume. A paused instance is instead bounded by the retention window `paused_expire_at`, after which the instance and its disk are both reclaimed. operationId: pauseSandbox parameters: - $ref: '#/components/parameters/SandboxIdPathParam' responses: '202': description: Pause accepted; poll the detail endpoint for the settled state. content: application/json: schema: $ref: '#/components/schemas/SandboxLifecycleAcceptedResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': description: > State conflict (`Resource.StateConflict` or an operation-specific code), or the selected IDC is under maintenance (`IDC.UnderMaintenance`): write operations are rejected until the IDC is usable again. Read operations are unaffected. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '499': $ref: '#/components/responses/RequestCanceled' '500': $ref: '#/components/responses/InternalError' '504': $ref: '#/components/responses/RequestTimeout' components: parameters: SandboxIdPathParam: name: id in: path required: true description: >- Unique sandbox resource ID (UUID; the `id` field of the create response). The data-plane key (`sandbox_key`) cannot be used here. schema: type: string format: uuid example: 3f6f0d3e-6f0a-4a2e-9c58-0d3e6f0a4a2e schemas: SandboxLifecycleAcceptedResponse: type: object description: Shared 202 acceptance body for pause and resume. required: - request_id - data properties: request_id: type: string description: Request tracing ID data: type: object required: - id - state properties: id: type: string format: uuid state: type: string enum: - pausing - paused - resuming - running description: > State on the row at the moment of acceptance, **not** the final outcome: it is `pausing` for a pause, and `resuming` (or `running` when the backing infrastructure settles within the request) for a resume. Always treat `GET /sandboxes/{id}` as authoritative for the settled state. example: pausing ErrorResponse: type: object required: - code - message - request_id properties: code: type: string description: Machine-readable business error code example: Resource.QuotaExceeded message: type: string description: Human-readable error description example: The resource quota is not enough. request_id: type: string description: Tracing ID example: req-xxxx trace_id: type: string description: >- Server-side trace identifier for this request; quote it when reporting a problem. details: type: object description: Field-level error details additionalProperties: true responses: BadRequest: description: >- Invalid request parameters. Two code families are used: `Request.InvalidParameter` for request parsing and format validation (unknown or malformed body fields, malformed IDs, invalid enum values, out-of-range paging) and `Parameter.Invalid` for business validation (for example a template or IDC that cannot be found, or a `timeout` over the limit). Unknown or invalid fields inside the `params` of `POST /sandboxes/{id}/actions` are reported as `Parameter.Invalid`. Other 400 codes are specific to an operation, for example `Sandbox.SourceConflict` (both or neither of `template_id` and `snapshot_id`) and `Sandbox.IdempotentParameterMismatch` (an `Idempotency-Key` reused with different parameters). Both code families share the same HTTP status, so decide by the `code` value, not the status alone. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Parameter.Invalid message: Invalid request parameters request_id: req-xxxx Unauthorized: description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Auth.Unauthorized message: Authentication required request_id: req-xxxx Forbidden: description: The caller cannot access the organization-scoped resource. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Resource.NotFound message: The requested resource was not found request_id: req-xxxx RequestCanceled: description: The caller canceled the current HTTP request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Request.Canceled message: Request canceled request_id: req-xxxx InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: System.Internal message: An internal server error occurred request_id: req-xxxx RequestTimeout: description: The current HTTP request exceeded the control-plane processing deadline. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Request.Timeout message: Request timed out request_id: req-xxxx securitySchemes: bearerAuth: type: http scheme: bearer description: > API Key or Access Token, always sent as `Authorization: Bearer `. The gateway recognizes the token type automatically. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.