v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Snapshots

Upload a Snapshot

Upload a new snapshot with image metadata.

The request body is a JSON object containing app_id (required), images (required, a mapping of filenames to image metadata objects), and optional VCS fields (head_sha, base_sha, provider, head_repo_name, head_ref, base_repo_name, base_ref, pr_number).

When VCS info with a base_sha is provided and a matching base snapshot exists, a comparison is automatically triggered.

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

post/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprodartifacts/snapshots/

Path parameters

organization_id_or_slugstring required

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

project_id_or_slugstring required

The ID or slug of the project the resource belongs to. Project slugs are unique within each organization.

Response

artifactIdstring required
snapshotMetricsIdstring required
imageCountinteger required
snapshotUrlstring required