Skip to main content
GET
Download 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, name, or resource path A resource path like 'sfc:image:acme:prod:my-image' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (image_[0-9a-zA-Z_-]{1,21}|vmi_[0-9a-zA-Z_-]{1,21})|(sfc:image:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
Example:

"image_k3R-nX9vLm7Qp2Yw5Jd8F"

Response

Download URL generated

url
string
required

Presigned download URL.

expires_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

sha256
string
required

For integrity verification.

Required string length: 64
Pattern: ^[a-f0-9]{64}$
Example:

"e3b0c44298fc1c149af..."

size
integer<u-int64>
required

Image size in bytes.

Required range: x >= 0