Contents

Read Build Action Information

Get information about a specific action Xcode Cloud performed as part of a build.

URL

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

Path Parameters

NameTypeDescription
id Requiredstring

The opaque resource ID that uniquely identifies the Build Actions resource.

Query Parameters

NameTypeDescription
fields[ciBuildActions] Optional[string]

Additional fields to include for the Build Actions resource returned by the response.

include Optional[string]

The relationship data to include in the response.

fields[ciBuildRuns] Optional[string]

Additional fields to include for the Build Actions resource returned by the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CiBuildActionResponse

The request completed successfully.

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.

404Not Found
Content-Type: application/json
ErrorResponse

Resource not found.

429
Content-Type: application/json
ErrorResponse

Discussion

The example request below retrieves detailed information about an action Xcode Cloud performed. It also requests detailed information about the action’s build by including the Build Runs resource in the query. Use the information provided in the response to display information on a dashboard or to access additional information; for example, information about other actions Xcode Cloud performed during the build.

Example Request and Response

See Also

Getting Build Actions