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.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:orchestration-write.
objectunionThe targets of the schedule.
stringThe target branch the build should run on.
list<BranchName>The branches to retrieve JobSpecs from if no JobSpec is found on the target branch.
booleanWhether to ignore staleness information when running the build.
integerThe number of retry attempts for failed jobs.
objectThe duration to wait before retrying after a Job fails.
booleanIf any job in the build is unsuccessful, immediately finish the build by cancelling all other jobs.
booleanThe notification will be sent to the user that has most recently edited the schedule.
No notification will be sent if the schedule has scopeMode set to ProjectScope.
objectstringThe RID of a build.
stringThe branch that the build is running on.
stringThe timestamp that the build was created.
stringThe user who created the build.
list<BranchName>The branches to retrieve JobSpecs from if no JobSpec is found on the target branch.
integerThe 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.
objectThe duration to wait before retrying after a Job fails.
booleanIf any job in the build is unsuccessful, immediately finish the build by cancelling all other jobs.
string (enum)The status of the build.
Enum values: RUNNING, SUCCEEDED, FAILED, CANCELED
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/orchestration/builds/create?preview=true" \
-d '{"abortOnFailure":false,"retryBackoffDuration":{"unit":"SECONDS","value":30},"retryCount":1,"fallbackBranches":["master"],"branchName":"master"}'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"
}