Read the Xcode Cloud Build Information for a Build Action

Get Xcode Cloud build information for a given build action.

URL

GET https://api.appstoreconnect.apple.com/v1/ciBuildActions/{id}/buildRun

Path Parameters

Name	Type	Description
`id` Required	string	The opaque resource ID that uniquely identifies the Build Actions resource.

Query Parameters

Name	Type	Description
`fields[builds]` Optional	[string]	Additional fields to include for each Build Runs resource returned by the response.
`fields[ciBuildRuns]` Optional	[string]	Additional fields to include for each Build Runs resource returned by the response.
`include` Optional	[string]	The relationship data to include in the response.
`limit[builds]` Optional	integer	The number of included Build Runs resources to return if the builds relationship is included.
`fields[scmGitReferences]` Optional	[string]
`fields[ciWorkflows]` Optional	[string]
`fields[scmPullRequests]` Optional	[string]
`fields[ciProducts]` Optional	[string]

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`CiBuildRunResponse`	The request completed successfully.
400	Bad Request Content-Type: application/json	`ErrorResponse`	An error occurred with your request.
401	Unauthorized Content-Type: application/json	`ErrorResponse`
403	Forbidden Content-Type: application/json	`ErrorResponse`	Request not authorized.
404	Not Found Content-Type: application/json	`ErrorResponse`	Resource not found.
429	Content-Type: application/json	`ErrorResponse`

Discussion

The example request below retrieves detailed information for a specific action Xcode Cloud performed. Use the data provided in the response to display detailed build information on a dashboard or to access related information.

Read the Xcode Cloud Build Information for a Build Action

URL

Path Parameters

Query Parameters

Response Codes

Discussion

Example Request and Response

See Also

Getting Build Actions