Skip to content

GET /api/registry/images

Updated

List registry images visible to this Lite host.

PropertyValue
Scoperead
Request bodynone
Success200 OK

Endpoint

GET ${baseUrl}/api/registry/images
read

Read the image catalog visible to this Lite host.

Use your host URL and API key as shell variables:

baseUrl="https://agent.example.com"
VIRT_AGENT_API_KEY="<your-api-key>"

cURL template

curl --request GET "${baseUrl}/api/registry/images" \
  --header "Authorization: Bearer ${VIRT_AGENT_API_KEY}"
LocationNameTypeRequiredDescription
HeaderAuthorizationbearer tokenyesBearer ${VIRT_AGENT_API_KEY}.
QuerydistrostringnoFilter by distro, such as debian or fedora.
QueryversionstringnoFilter by distro version.
QuerylatestbooleannoWhen true, only return images marked latest by the registry.

Returns an array of registry image objects.

FieldTypeDescription
idstringOpaque registry image id. Use with GET /api/registry/images/{id}.
distrostringDistro label.
versionstringDistro version.
archstringCPU architecture, such as x86_64.
release_idstringUpstream release identifier.
filenamestringSource image filename.
download_urlstringURL the Lite host can fetch when creating or caching the image.
checksum_algostringChecksum algorithm, usually sha256 or sha512.
checksumstringExpected checksum value.
file_sizeinteger or nullSize in bytes when known.
is_latestbooleanWhether this is the latest enabled image for its distro/version group.
sourcestringRegistry ingestion source.
enabledbooleanWhether this image is enabled in the registry.
discovered_atstringRegistry discovery timestamp.
created_atstringRegistry record creation timestamp.
Terminal window
baseUrl="https://agent.example.com"
VIRT_AGENT_API_KEY="<your-api-key>"
curl "${baseUrl}/api/registry/images?distro=debian&latest=true" \
--header "Authorization: Bearer ${VIRT_AGENT_API_KEY}"
[
{
"id": "debian-13-x86_64-20260703",
"distro": "debian",
"version": "13",
"arch": "x86_64",
"release_id": "20260703",
"filename": "debian-13-x86_64.qcow2",
"download_url": "https://images.example.com/debian-13-x86_64.qcow2",
"checksum_algo": "sha256",
"checksum": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"file_size": 8589934592,
"is_latest": true,
"source": "public-registry",
"enabled": true,
"discovered_at": "2026-07-03T10:00:00Z",
"created_at": "2026-07-03T10:00:00Z"
}
]
StatusCodeDescription
400BAD_REQUESTImage registry is not configured on the Lite host.
401UNAUTHORIZEDAPI key is missing or invalid.
403FORBIDDENAPI key is valid but not allowed to access the endpoint.
500STORAGE_ERRORRegistry request or response parsing failed.