Compute

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

List and query machine images in the active scope

GET
/scopes/{scopeId}/compute/images

Returns the machine images (public marketplace images and private, org-authored golden images) visible in the active tenant/subscription/project scope, as rendered by the the Images page table. This single collection endpoint serves BOTH the plain route-load list and the search/filter/sort/pagination controls: free-text q matches image name and OS, the UI's quick-filter chips map to the visibility (Public/Private) and arch (arm64) query parameters, and the table sorts on name, sizeGb and createdAt via sort+order. No resource state is mutated by this call. Validation: scopeId must resolve to an accessible scope or the request fails with 403 FORBIDDEN; unknown sort fields, non-enum visibility/arch/status/os values or out-of-range page/pageSize map to 422 VALIDATION_ERROR. Soft-deleted images are always excluded (deleted_at IS NULL). Async & state: Synchronous read; no state change. Returns a stable snapshot suitable for the table; live status transitions arrive over the realtime channel as resource.updated frames keyed by image id. Errors: 401 when the session is missing/expired; 403 when the caller lacks reader access to the scope; 422 on malformed query parameters; 500 on backend read-model failure. Idempotency/Concurrency: Safe, cacheable; no idempotency key required. Pagination is cursor-stable per meta so repeated reads with identical parameters return consistent pages.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

Query Parameters

region?string

Restrict the result set to a single region.

Match^[a-z][a-z0-9-]{1,39}$
q?string

Free-text search.

sort?string

Field to sort by (entity-specific; defaults to the entity's natural order).

order?string

Sort direction.

Default"asc"
Value in"asc""desc"
page?integer

1-based page number.

Range1 <= value
Default1
pageSize?integer

Items per page (max 200).

Range1 <= value <= 200
Default50
visibility?string

Filter by image visibility (UI quick-filter chips "Public" / "Private").

Value in"Public""Private"
arch?string

Filter by CPU architecture (UI quick-filter chip "Arm64").

Value in"x86_64""arm64"
status?string

Filter by image lifecycle status.

Value in"AVAILABLE""PENDING""DEPRECATED""DELETING""ERROR"
os?string

Filter by operating-system family.

Value in"ubuntu""debian""rhel""rocky""alma""windows""linux"

Response Body

Paginated collection of machine images visible in the scope.

application/json
  1. response
data*array<>
meta*

Pagination envelope metadata. List responses are always { data, meta } — never a naked array.

curl -X GET "https://example.com/scopes/string/compute/images"
{  "data": [    {      "id": "string",      "name": "string",      "description": "string",      "os": "ubuntu",      "osName": "string",      "osVersion": "string",      "visibility": "Public",      "sizeGb": 0,      "arch": "x86_64",      "source": {        "kind": "instance",        "ref": "string"      },      "status": "AVAILABLE",      "statusReason": "string",      "encrypted": true,      "kmsKeyId": "string",      "minDiskGb": 0,      "minRamMb": 0,      "bootMode": "UEFI",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "shares": [        {          "accountId": "string",          "accountName": "string",          "sharedAt": "2019-08-24T14:15:22Z"        }      ],      "versions": [        {          "version": "string",          "createdAt": "2019-08-24T14:15:22Z",          "sizeGb": 0,          "isLatest": true,          "note": "string"        }      ]    }  ],  "meta": {    "page": 1,    "pageSize": 1,    "total": 0,    "hasNext": true  }}