Skip to main content
Read one exact Tool setup and its durable outcome

Authorizations

Authorization
string
header
required

Opaque control credential

Path Parameters

projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
setupId
string
required
Pattern: ^setup_[0-9a-z]{12,32}$

Response

Saved Tool setup

schemaVersion
enum<number>
required
Available options:
1
setupId
string
required
Pattern: ^setup_[0-9a-z]{12,32}$
organizationId
string
required
Pattern: ^org_[0-9a-z]{12,32}$
projectId
string
required
Pattern: ^prj_[0-9a-z]{12,32}$
operationId
string
required
Pattern: ^op_[0-9a-z]{12,32}$
requestHash
string
required
Pattern: ^sha256:[0-9a-f]{64}$
request
object
required
state
enum<string>
required
Available options:
pending,
building,
preparing,
ready,
failed,
cancelled
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
createdBy
string
required
Required string length: 1 - 255
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
source
object
buildAttemptId
string
Pattern: ^attempt_[0-9a-z]{12,32}$
buildOperationId
string
Pattern: ^op_[0-9a-z]{12,32}$
buildHash
string
Pattern: ^sha256:[0-9a-f]{64}$
environmentId
string
Pattern: ^env_[0-9a-z]{12,32}$
preparationOperationId
string
Pattern: ^op_[0-9a-z]{12,32}$
error
object
finishedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991