> ## 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. # Connect to a sandbox > Connects to a running sandbox and returns its data-plane connection info (domain and access token). When `timeout` is provided and greater than 0, the call also extends the sandbox's lifetime (extend-only, never shortens). Returns 409 if the instance is not running. The response always returns the authoritative expiry time `end_at` as settled by this call — if no extension took effect (the requested expiry is not later than the current one), it is simply the unchanged current value. **The `sandbox_access_token` stays valid for the entire lifetime of the sandbox. When the lifetime is extended, the control plane re-signs and returns a new token; even without an extension, if the token has drifted from the sandbox's current `end_at`, this endpoint repairs it.** ## OpenAPI ````yaml /api-spec/sandbox_api.yaml post /sandboxes/{id}/connect 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}/connect: post: tags: - Sandbox summary: Connect to a sandbox description: > Connects to a running sandbox and returns its data-plane connection info (domain and access token). When `timeout` is provided and greater than 0, the call also extends the sandbox's lifetime (extend-only, never shortens). Returns 409 if the instance is not running. The response always returns the authoritative expiry time `end_at` as settled by this call — if no extension took effect (the requested expiry is not later than the current one), it is simply the unchanged current value. **The `sandbox_access_token` stays valid for the entire lifetime of the sandbox. When the lifetime is extended, the control plane re-signs and returns a new token; even without an extension, if the token has drifted from the sandbox's current `end_at`, this endpoint repairs it.** operationId: connectSandbox parameters: - $ref: '#/components/parameters/SandboxIdPathParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/ConnectSandboxControlRequest' responses: '200': description: Connected content: application/json: schema: $ref: '#/components/schemas/ConnectSandboxControlResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalError' 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: ConnectSandboxControlRequest: type: object properties: timeout: type: integer format: int64 description: >- When greater than 0, extends the lifetime of a running sandbox (extend-only, never shortens). ConnectSandboxControlResponse: type: object required: - request_id - data properties: request_id: type: string description: Request tracing ID data: $ref: '#/components/schemas/ConnectSandboxControlResult' ConnectSandboxControlResult: type: object description: > Same shape as the creation response: identity and data-plane entry point only — no template alias, no backing node identifiers, no agent version. Those are backend concepts the caller can neither act on nor interpret. required: - id - sandbox_key - template_id - domain - sandbox_access_token - traffic_access_token - end_at properties: id: type: string format: uuid description: >- Unique sandbox resource ID (UUID), used both in control-plane path parameters and as the billing resource_id. sandbox_key: type: string description: > Data-plane addressing key (an `i` followed by a 20-character random string). Used solely to assemble data-plane URLs: `https://{sandbox_key}.{domain}` and `https://{port}-{sandbox_key}.{domain}`. Control-plane endpoints always use `id` and do not accept this field. template_id: type: string domain: type: string description: > Sandbox data-plane domain — the host suffix for data-plane endpoints such as `/files` (`https://{sandbox_key}.{domain}`). Re-read this field and `sandbox_access_token` on every connect; do not reuse values cached from a previous create/connect. sandbox_access_token: type: string description: > Sandbox data-plane access token (always issued). Sent as the `X-Access-Token` header on `/files`, Sandbox-Exec, and other data-plane endpoints; the control plane (`/api/v2`) does not use it. The `sandbox_access_token` stays valid for the entire lifetime of the sandbox. Connect may return a new token when it extends the lifetime or repairs drift; always overwrite the local cache with this response instead of assuming it equals the previous create/connect value. traffic_access_token: type: string description: > Traffic token for non-control ports (issued only when secure=true; sent as the traffic-access-token header). Empty when secure=false. end_at: type: string format: date-time description: > The authoritative expiry time (UTC) as settled by this connect call. Returned whether or not `timeout` was passed: an extension takes effect only when the requested expiry is later than the current one (extend-only), and when it does not take effect this is simply the unchanged current value — callers cannot derive the effective value from their own request parameters. 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 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 Conflict: description: State conflict content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Resource.StateConflict message: Resource state conflict request_id: req-xxxx InternalError: description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: code: Internal.ServerError message: An internal server error occurred 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. ````