Skip to main content
Acquire a catalog Tool release

Authorizations

Authorization
string
header
required

Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use.

Headers

Idempotency-Key
string
required

Save a unique stable key for this exact logical action, at most 200 characters. Reuse it with identical input after an uncertain response. A new key is new intent; it must not be used merely to recover an accepted action.

Required string length: 1 - 200

Body

application/json
projectId
string
required
Required string length: 1 - 160
environmentId
string
required
Required string length: 1 - 160
catalogId
string
required
Pattern: ^[a-z][a-z0-9-]{0,63}$
releaseDigest
string
required
Pattern: ^sha256:[a-f0-9]{64}$
initialData
enum<string>
required
Available options:
empty,
starter

Response

The retained resource or operation response.

schemaVersion
string
required
Allowed value: "2026-10-15-catalog.1"
id
string
required
phase
enum<string>
required
Available options:
prepared,
building,
seeding,
ready,
failed,
uncertain
buildId
null | string
required
datasetId
null | string
required
error
null | object
required
createdAt
string
required
updatedAt
string
required
catalogId
string
required
releaseDigest
string
required
initialData
enum<string>
required
Available options:
empty,
starter
projectId
string
required
environmentId
string
required