> ## 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. # Set sandbox timeout > Resets the time-to-live relative to the current time. When `timeout` is omitted or is 0 or less, 300 seconds is used. Only allowed while `running`; any other state returns 409. The response returns the expiry time before and after this change: since a `timeout` of 0 or less is replaced by the default duration, callers cannot derive the effective value from their own request parameters — treat `new_end_at` in the response as authoritative. **The `sandbox_access_token` stays valid for the entire lifetime of the sandbox. After extending the lifetime, call the connect endpoint again to obtain a new token.** ## OpenAPI ````yaml /api-spec/sandbox_api.yaml post /sandboxes/{id}/timeout openapi: 3.0.3 info: title: GMI Sandbox API description: >- REST API for GMI Sandbox: create isolated execution environments from templates, 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: 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-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}/timeout: post: tags: - Sandbox summary: Set sandbox timeout description: > Resets the time-to-live relative to the current time. When `timeout` is omitted or is 0 or less, 300 seconds is used. Only allowed while `running`; any other state returns 409. The response returns the expiry time before and after this change: since a `timeout` of 0 or less is replaced by the default duration, callers cannot derive the effective value from their own request parameters — treat `new_end_at` in the response as authoritative. **The `sandbox_access_token` stays valid for the entire lifetime of the sandbox. After extending the lifetime, call the connect endpoint again to obtain a new token.** operationId: setSandboxTimeout parameters: - $ref: '#/components/parameters/SandboxIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetSandboxControlTimeoutRequest' responses: '200': description: Timeout set; returns the expiry time before and after the change. content: application/json: schema: $ref: '#/components/schemas/SetSandboxControlTimeoutResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/SandboxMutationFailed' '500': $ref: '#/components/responses/SandboxMutationFailed' 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: SetSandboxControlTimeoutRequest: type: object properties: timeout: type: integer format: int64 description: >- Time-to-live in seconds, measured from the current time. When omitted or 0 or less, 300 seconds is used. SetSandboxControlTimeoutResponse: type: object required: - request_id - data properties: request_id: type: string description: Request tracing ID data: type: object required: - id - old_end_at - new_end_at properties: id: type: string format: uuid description: Unique sandbox resource ID. old_end_at: type: string format: date-time description: The expiry time (UTC) before this change. new_end_at: type: string format: date-time description: > The expiry time (UTC) in effect after this change. When a `timeout` of 0 or less is replaced by the default duration, this field is authoritative. 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 details: type: object description: Field-level error details additionalProperties: true SandboxMutationErrorResponse: description: > Error response for a failed runtime mutation. The top level keeps the platform's standard error envelope (ErrorResponse); the sandbox-specific `state` / `last_mutation` go in `details` without altering the top-level structure. allOf: - $ref: '#/components/schemas/ErrorResponse' - type: object properties: details: type: object properties: state: type: string description: >- The sandbox's actual lifecycle state after this operation failed last_mutation: $ref: '#/components/schemas/SandboxMutationResult' SandboxMutationResult: type: object description: > The most recent operation and its outcome. status=pending means the command has been accepted but the outcome has not settled yet (asynchronous creation and deletion are in this state right after acceptance). required: - type - status properties: type: type: string enum: - create - delete - set_timeout status: type: string enum: - pending - succeeded - failed error_code: type: string example: invalid_argument message: type: string description: Sanitized failure reason; never contains access tokens completed_at: type: string format: date-time responses: BadRequest: description: Invalid request parameters 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 SandboxMutationFailed: description: > A runtime mutation started but was deterministically rejected by the backing infrastructure. The top level is the platform's standard error envelope; `details` additionally carries `state` and `last_mutation`, indicating the sandbox is still running while this operation failed. content: application/json: schema: $ref: '#/components/schemas/SandboxMutationErrorResponse' example: code: Resource.StateConflict message: 'Sandbox state conflict: current updating, required running' request_id: req-xxxx details: state: running last_mutation: type: set_timeout status: failed error_code: invalid_argument message: timeout update rejected by runtime completed_at: '2026-08-13T09:12:31Z' securitySchemes: bearerAuth: type: http scheme: bearer description: > API Key or Access Token, always sent as `Authorization: Bearer `. The gateway recognizes the token type automatically. ````