> ## 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 the product catalog (unified, tenant-facing) > Unified product catalog query: identity, display name, status and resources per product. This is a config-plane read view for tenants — it carries no inventory and no purchasability judgement; whether a given operation may use a product is answered by that operation's own validation. `status` is externally two-valued: `active` / `unavailable` (internal operational states are not exposed). The contract covers all resource types; this release serves `resource_type=sandbox` only (also the default), other values return 400. ## OpenAPI ````yaml /api-spec/sandbox_api.yaml get /products 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: /products: get: tags: - SandboxTemplate summary: List the product catalog (unified, tenant-facing) description: | Unified product catalog query: identity, display name, status and resources per product. This is a config-plane read view for tenants — it carries no inventory and no purchasability judgement; whether a given operation may use a product is answered by that operation's own validation. `status` is externally two-valued: `active` / `unavailable` (internal operational states are not exposed). The contract covers all resource types; this release serves `resource_type=sandbox` only (also the default), other values return 400. operationId: listProductCatalog parameters: - $ref: '#/components/parameters/IdcNameRequiredQueryParam' - name: resource_type in: query description: Resource type to list. Only `sandbox` is served in this release. schema: type: string enum: - sandbox default: sandbox - name: include_unavailable in: query description: Include products whose status is `unavailable`. schema: type: boolean default: false responses: '200': description: Product catalog entries were returned successfully. content: application/json: schema: $ref: '#/components/schemas/ProductCatalogListResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalError' components: parameters: IdcNameRequiredQueryParam: name: idc_name in: query required: true description: IDC identifier used for capability and resource resolution. schema: type: string schemas: ProductCatalogListResponse: type: object additionalProperties: false required: - request_id - data properties: request_id: type: string description: HTTP request correlation identifier. data: type: array items: $ref: '#/components/schemas/ProductCatalogItem' ProductCatalogItem: type: object additionalProperties: false required: - resource_type - product - name - status - resources description: | One product catalog entry: identity, display name, externally-visible status and effective resources. Carries no inventory and no purchasability judgement. properties: resource_type: type: string enum: - sandbox description: >- Resource type of this entry. Only `sandbox` is served in this release. product: type: string description: Catalog SKU (for example `gmi.sandbox.x-large`). name: type: string description: >- Display name of the product (for sandbox, the preset label such as `SMALL`). status: type: string enum: - active - unavailable description: | Externally two-valued status. `active` = on sale; `unavailable` covers every internal non-usable state. resources: $ref: '#/components/schemas/EffectiveResources' 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 EffectiveResources: type: object additionalProperties: false required: - cpu_count - memory_mb - disk_size_mb - architecture properties: cpu_count: type: integer minimum: 1 description: | Effective integer vCPU count. Operator-managed presets do not use the custom-resource maximum. memory_mb: type: integer minimum: 1 description: | Effective memory size in MiB. Operator-managed presets are not constrained by custom-resource limits. disk_size_mb: type: integer minimum: 1 description: | Effective boot disk size in MiB. Operator-managed presets are not constrained by custom-resource limits. architecture: type: string enum: - x86_64 - arm64 description: | CPU architecture resolved for the selected IDC. 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' 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. ````