Skip to main content
Read the current drill-suite state

Authorizations

Authorization
string
header
required

Opaque control credential

Path Parameters

ciSuiteId
string
required
Pattern: ^cisuite_[0-9a-z]{12,32}$

Response

Current suite

schemaVersion
enum<number>
required
Available options:
1
ciSuiteId
string
required
Pattern: ^cisuite_[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}$
environmentId
string
required
Pattern: ^env_[0-9a-z]{12,32}$
repositoryBindingId
string
required
Pattern: ^repo_[0-9a-z]{12,32}$
credentialId
string
required
Pattern: ^cred_[0-9a-z]{12,32}$
provider
enum<string>
required
Available options:
github_actions,
service
suiteKey
string
required
Required string length: 1 - 96
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]*$
source
object
required
evidenceUrl
string<uri>
required
Maximum string length: 2048
state
enum<string>
required
Available options:
preparing,
running,
cancelling,
completed,
failed,
cancelled
builds
object[]
required
Required array length: 1 - 2 elements
counts
object
required
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
ciInvocationId
string
Pattern: ^ci_[0-9a-z]{12,32}$
cancellationReason
string
Required string length: 1 - 1000
conclusion
enum<string>
Available options:
passed,
failed,
inconclusive,
error,
cancelled
result
object
githubReviewDelivery
object
policy
object
failure
object
finishedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991