Skip to main content

images

Creates, updates, deletes, gets or lists an images resource.

Overview

Nameimages
TypeResource
Idvercel.vcr.images

Fields

The following fields are returned by SELECT queries:

A single image with its tags, status and resolved Dockerfile layer history.

NameDatatypeDescription
idstringInternal identifier of the image. (example: img_a1b2c3d4e5f6)
repository_idstringIdentifier of the repository the image belongs to. (example: repo_a1b2c3d4e5f6) (wire: repositoryId)
archstringCPU architecture the manifest targets. Only present for single-platform manifests. (example: amd64)
created_atstringISO 8601 timestamp of when the image was created. (example: 2026-06-30T10:00:00.000Z) (wire: createdAt)
kindstringWhether the manifest is a multi-platform image index, a single-platform image manifest or an attestation. (attestation, index, manifest)
layersarray
manifest_digeststringSHA-256 digest of the image manifest. (example: sha256:2c4e8f3a1b9d0e5c7a6f4b2d8e1c9a0b3d5f7e9c1a2b4d6f8e0c2a4b6d8f0e2c) (wire: manifestDigest)
platformstringOperating system the manifest targets. Only present for single-platform manifests. (example: linux)
pushed_bystringIdentifier of the actor that pushed the image. (wire: pushedBy)
size_in_bytesnumberTotal size in bytes of the image's resources (manifest, config and layer blobs) stored by the registry. (wire: sizeInBytes)
statusstringVHS-readiness status, or null for a multi-platform index. (preparing, ready, unoptimized, )
tagsarrayTags pointing at this image's manifest.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectproject_id, id_or_name, image_id_or_digestteam_id, slugFetch an individual image from a repository, including its tags and Dockerfile history entries with discriminated layer details for UI rendering. The image may be addressed by its internal id (image_...) or by its manifest digest (sha256:...).
listselectproject_id, id_or_namelimit, cursor, untagged, team_id, slugList images for a container registry repository, including their tags.
deletedeleteproject_id, id_or_name, image_idteam_id, slugSchedule an image for deletion. The image is marked so it disappears from list/get immediately; subscriber-vcr reclaims the manifest, blobs, tags and row asynchronously via the VcrManifestRemoved event.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
id_or_namestring
image_idstring
image_id_or_digeststringThe internal image id (image_...) or the image manifest digest (sha256:...).
project_idstringProject ID. Missing or empty values return HTTP 400. (wire: projectId)
cursorstringOpaque pagination cursor returned by a previous list response.
limitinteger
slugstringThe Team slug to perform the request on behalf of.
team_idstringThe Team identifier to perform the request on behalf of. (wire: teamId)
untaggedboolean

SELECT examples

Fetch an individual image from a repository, including its tags and Dockerfile history entries with discriminated layer details for UI rendering. The image may be addressed by its internal id (image_...) or by its manifest digest (sha256:...).

SELECT
id,
repository_id,
arch,
created_at,
kind,
layers,
manifest_digest,
platform,
pushed_by,
size_in_bytes,
status,
tags
FROM vercel.vcr.images
WHERE project_id = '{{ project_id }}' -- required
AND id_or_name = '{{ id_or_name }}' -- required
AND image_id_or_digest = '{{ image_id_or_digest }}' -- required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;

DELETE examples

Schedule an image for deletion. The image is marked so it disappears from list/get immediately; subscriber-vcr reclaims the manifest, blobs, tags and row asynchronously via the VcrManifestRemoved event.

DELETE FROM vercel.vcr.images
WHERE project_id = '{{ project_id }}' --required
AND id_or_name = '{{ id_or_name }}' --required
AND image_id = '{{ image_id }}' --required
AND team_id = '{{ team_id }}'
AND slug = '{{ slug }}'
;