Contents

Start a Build

Start a new Xcode Cloud build for a workflow.

URL

POST https://api.appstoreconnect.apple.com/v1/ciBuildRuns

Response Codes

StatusReasonTypeDescription
201Created
Content-Type: application/json
CiBuildRunResponse

The request completed successfully and a new Build Runs resource has been created.

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

409Conflict
Content-Type: application/json
ErrorResponse

The provided resource data is not valid.

422
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

Discussion

The example request below starts a new build for a specific workflow. Use the information provided in the response to display build information on a dashboard or to access additional information; for example, the actions Xcode Cloud performs during the build.

Example Request and Response

HTTP Body

The request body you use to start a new Xcode Cloud build.