SFsfcompute
Images

List images

Changed on

⚠️ 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

Request

  • Base URL
    https://api.sfcompute.com
  • URL
    https://api.sfcompute.com/preview/v2/images
  • Auth
    HTTP bearer

Query parameters

workspacestring required

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

Filter by workspace. Pass sfc:workspace:sfcompute:public to list sfc-provided public images.

idSfcApiImageId[]

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

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

Changes