Search documentation
karat

+

K

User Documentation ↗

Get Build

GET/api/v2/orchestration/builds/{buildRid}
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Get the Build with the specified rid.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-read.

Path parameters

buildRid
string

The RID of a build.

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Response body

Build
object
Hide child attributes

Hide child attributes

rid
string

The RID of a build.

branchName
string

The branch that the build is running on.

createdTime
string

The timestamp that the build was created.

createdBy
string

The user who created the build.

fallbackBranches
list<BranchName>
optional

The branches to retrieve JobSpecs from if no JobSpec is found on the target branch.

Show child attributes

Show child attributes

retryCount
integer

The number of retry attempts for failed Jobs within the Build. A Job's failure is not considered final until all retries have been attempted or an error occurs indicating that retries cannot be performed. Be aware, not all types of failures can be retried.

retryBackoffDuration
object

The duration to wait before retrying after a Job fails.

Show child attributes

Show child attributes

abortOnFailure
boolean

If any job in the build is unsuccessful, immediately finish the build by cancelling all other jobs.

status
string (enum)

The status of the build.

Enum values: RUNNING, SUCCEEDED, FAILED, CANCELED

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/orchestration/builds/ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "abortOnFailure": false, "createdBy": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", "retryBackoffDuration": { "unit": "SECONDS", "value": 30 }, "retryCount": 1, "fallbackBranches": [ "master" ], "branchName": "master", "createdTime": "2003-05-06T12:34:56.789Z", "rid": "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58", "status": "RUNNING" }