Skip to navigation

Read a catalogue Variant revision

One immutable revision: its application definitions as compiled, its decision_state, and two content digests (digest_version 1). authored_intent_digest identifies what was sent; approved_snapshot_digest identifies what renders, and is the value an approval names. A revision the variant does not have answers 404 VARIANT_NOT_FOUND. Requires the catalogue.read scope, which your account operator provisions; no other catalogue scope implies it. Served only where the catalogue is enabled for your environment.

Authentication

X-API-Keystring

API key for one environment of your account. Keep server-side; never expose in browser clients.

Path parameters

variant_idstringRequired
revisionstringRequired

Response

The revision
appearancemap from strings to any
applicationslist of objects
approved_snapshot_digeststringformat: "^sha256:[0-9a-f]{64}$"
authored_intent_digeststringformat: "^sha256:[0-9a-f]{64}$"
created_atdatetime
decided_atdatetime or null
decision_stateenum
Allowed values:
default_application_idstring
digest_versionenum
Allowed values:
display_colorstringformat: "^#[0-9A-F]{6}$"
revisioninteger>=1
variant_idstring

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error