Skip to main content
GET
Read a stack profile summary generation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

generation_id
string<uuid>
required

Response

Current authorized summary state

id
string<uuid>
required
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled,
expired,
superseded
review_state
enum<string>
required
Available options:
unreviewed,
approved,
rejected,
stale
revision
integer
required
Required range: x >= 1
candidate_revision
integer
required
Required range: x >= 0
summary_revision
integer
required

Current approved-pointer revision to supply as expected_approved_revision when reviewing; advances on withdrawal too.

Required range: x >= 0
source_revision
integer
Required range: x >= 1
outcomes
object[]
Maximum array length: 5
selection
object[]
Maximum array length: 5
facts
object[]
Maximum array length: 512
coverage
object[]
Maximum array length: 256
parameters
object[]
Maximum array length: 64
error_code
enum<string>
Available options:
quota_exceeded,
provider_unavailable,
unsupported_source,
stale_source,
invalid_output,
cancelled,
timed_out,
permission_denied