Skip to main content
GET
Get image

Authorizations

Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Path Parameters

id
string
required

Image ID or resource path, optionally pinned with an @ suffix Image ID, or a resource path optionally pinned to one version with an @ suffix (e.g. sfc:image:sfcompute:public:ubuntu-22.04@2). Unpinned paths follow the latest active version of the name.

Response

Image details

id
required

Accepts the canonical prefix below; additional legacy prefixes are aliased for read compatibility. Writes always emit the canonical form.

Pattern: image_[0-9a-zA-Z_-]{1,21}
Example:

"image_k3R-nX9vLm7Qp2Yw5Jd8F"

resource_path
string
required

A resource path for a image resource. Format: sfc:image:::.

Pattern: sfc:image:([a-zA-Z0-9._-]+:){2}[a-zA-Z0-9._-]+
Example:

"sfc:image:<account_id>:<workspace>:<name>"

owner
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

workspace
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

workspace_id
string
required

The workspace that owns this image.

Pattern: wksp_[0-9a-zA-Z_-]{1,21}
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

name
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

is_public
boolean
required

Whether this is an sfc-provided public image.

object
string
default:image
required
read-only
Allowed value: "image"
upload_status
enum<string>
required
Available options:
started,
uploading,
completed,
failed,
revoked
created_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

version
integer<int32>

Version of this image within its name. Uploading an existing name creates the next version; each version is immutable. (default tolerates servers that predate the field: 0 = unreported.)

deprecated_at
null | integer<int64>

Set when this version is deprecated: it no longer resolves by name and is hidden from default listings, but can still be launched by id.

Example:

1738972800

provider
string | null
sha256
string | null
Required string length: 64
Pattern: ^[a-f0-9]{64}$