> ## 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. # List durable snapshots > Lists snapshots in the current tenant, including `deleting` and `delete_failed`. Deleted snapshots are excluded. Filtering by `status=deleted` returns 400. ## OpenAPI ````yaml /api-spec/sandbox_api.yaml get /snapshots 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: /snapshots: get: tags: - SandboxSnapshot summary: List durable snapshots description: > Lists snapshots in the current tenant, including `deleting` and `delete_failed`. Deleted snapshots are excluded. Filtering by `status=deleted` returns 400. operationId: listSandboxSnapshots parameters: - $ref: '#/components/parameters/IdcNameQueryParam' - name: source_sandbox_id in: query schema: type: string format: uuid - name: name in: query schema: type: string maxLength: 255 - name: status in: query schema: type: string enum: - creating - ready - error - deleting - delete_failed - $ref: '#/components/parameters/PageParam' - $ref: '#/components/parameters/PageSizeParam' responses: '200': description: Durable snapshots were returned successfully. content: application/json: schema: $ref: '#/components/schemas/ListSandboxSnapshotsResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' components: parameters: IdcNameQueryParam: name: idc_name in: query description: Filter by data center name, e.g. us-denver-1 schema: type: string PageParam: name: page in: query description: Page number, starting from 1; default 1 schema: type: integer minimum: 1 default: 1 PageSizeParam: name: page_size in: query description: Items per page; default 20, maximum 100 schema: type: integer minimum: 1 maximum: 100 default: 20 schemas: ListSandboxSnapshotsResponse: type: object required: - request_id - total - page - page_size - items properties: request_id: type: string total: type: integer format: int64 page: type: integer page_size: type: integer items: type: array items: $ref: '#/components/schemas/SandboxSnapshot' SandboxSnapshot: type: object required: - snapshot_id - idc_name - name - status - source_sandbox_id - source_template_id - source_build_id - vcpu - ram_mb - disk_size_mb - architecture - metadata - created_at - updated_at properties: snapshot_id: type: string format: uuid description: Stable durable snapshot identifier. idc_name: type: string name: type: string maxLength: 255 status: $ref: '#/components/schemas/SandboxSnapshotStatus' source_sandbox_id: type: string format: uuid source_template_id: type: string format: uuid source_build_id: type: string format: uuid vcpu: type: integer format: int64 ram_mb: type: integer format: int64 disk_size_mb: type: integer format: int64 architecture: type: string product: type: string description: Catalog SKU inherited from the source sandbox, when available. product_name: type: string description: Product display name inherited from the source sandbox. metadata: type: object additionalProperties: type: string failure_code: type: string description: Stable failure code, present on creation or deletion failure. status_reason: type: string description: Failure detail, present on creation or deletion failure. ready_at: type: string format: date-time description: Time the snapshot became ready. created_at: type: string format: date-time updated_at: type: string format: date-time 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 SandboxSnapshotStatus: type: string enum: - creating - ready - error - deleting - delete_failed 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' 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 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.