v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Snapshots

Retrieve Snapshot details

Retrieve full details for a snapshot, including categorized image lists and comparison status.

When a comparison exists (comparison_type is diff), images are categorized into changed, added, removed, renamed, unchanged, errored, and skipped lists with counts, and the top-level images array is empty because those images are already present in the categorized lists. For solo and waiting_for_base snapshots the categorized lists are empty and images is the only populated source. image_count is accurate in all modes.

Use compact_metadata=1 to strip image objects down to display_name, image_file_name, group, and description only.

This endpoint requires a bearer token with project:read access.

get/api/0/organizations/{organization_id_or_slug}/preprodartifacts/snapshots/{snapshot_id}/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

snapshot_idstring required

The ID of the snapshot.

Query parameters

compact_metadatastring

Set to '1' or 'true' to strip image metadata to display_name, image_file_name, group, and description only.

Response

head_artifact_idstring
base_artifact_idstring nullable
project_idstring
comparison_typestring
statestring
app_idstring nullable
is_selectiveboolean
image_countinteger
added_countinteger
removed_countinteger
renamed_countinteger
changed_countinteger
unchanged_countinteger
errored_countinteger
skipped_countinteger
diff_thresholdnumber double nullable
comparison_statestring nullable
approval_statusstring nullable
comparison_error_messagestring nullable