Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Images

List images

⚠️ This endpoint is in public preview.

List images in the specified workspace. Pass sfc:workspace:sfcompute:public as the workspace to list sfc-provided public images instead.

get/preview/v2/images

Query parameters

workspacestring

A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:wksp_k3R-nX9vLm7Qp2Yw5Jd8F

Scope the returned list to a single workspace (ID, resource path, or name). Without it, the returned list spans every workspace where the caller has Image:List and Image:Read (granted at either the workspace or organization level). Public images are not included by default - request them by specifying sfc:workspace:sfcompute:public for the workspace query parameter.

Filter by image ID (repeatable).

[
  "image_k3R-nX9vLm7Qp2Yw5Jd8F"
]
limitinteger

Maximum number of results to return (1-200, default 50).

starting_afterstring
Example:imagec_gqXR7s0Kj5mHvE2wNpLc4Q

Cursor for forward pagination (from a previous response's cursor field).

ending_beforestring
Example:imagec_gqXR7s0Kj5mHvE2wNpLc4Q

Cursor for backward pagination.

Response

Paginated list of images

object'list' required
cursorstring
has_moreboolean required

Example response

{
  "cursor": "imagec_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:image:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
      "name": "my-resource-name",
      "created_at": 1738972800
    }
  ]
}