Skip to main content
GET
List images
Requires the IAM action compute:ListImages. See COMPUTE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Query Parameters

crn
string

Exact resource CRN, intersected with all other filters before pagination. A foreign or mismatched CRN returns an empty page; malformed or empty CRNs return 400. Nested attachment lists filter the represented resource, not the binding.

limit
integer
default:20

Maximum number of items to return. A value above the maximum is clamped to it rather than rejected, so a page shorter than the one you asked for is normal — page until meta.has_more is false, not until a page looks short.

Required range: 1 <= x <= 100
marker
string

Opaque pagination cursor. Echo back the meta.marker value from the previous page to fetch the next one; do not construct or parse it. The token's internal form varies by endpoint (a resource ID, a timestamp, …) and is not guaranteed stable across releases.

os
string
Example:

"ubuntu"

architecture
string
Example:

"amd64"

name
string

Exact, case-sensitive name match; an empty value matches no named resource.

Example:

"ubuntu-24.04"

status
enum<string>
Available options:
pending,
importing,
active,
error,
deleting,
withdrawn
Example:

"active"

all_versions
boolean
default:false

Include builds a newer version has superseded. Off by default, when each tag contributes only the build worth launching.

Example:

true

Response

One page of images, ordered by name

images
object[]
required
meta
object