Contents

Read macOS Version Information

Get information about a specific macOS version that’s available to Xcode Cloud workflows.

URL

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

Path Parameters

NameTypeDescription
id Requiredstring

The opaque resource ID that uniquely identifies the macOS Versions resource.

Query Parameters

NameTypeDescription
fields[ciMacOsVersions] Optional[string]

Additional fields to include for the macOS Versions resource returned by the response.

fields[ciXcodeVersions] Optional[string]

Additional fields to include for the macOS Versions resource returned by the response.

include Optional[string]

The relationship data to include in the response.

limit[xcodeVersions] Optionalinteger

The number of included macOS Versions resources to return if the Xcode versions relationship is included.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CiMacOsVersionResponse

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 accesses information about a macOS version available to Xcode Cloud workflows. Use the data provided in the response to read additional information; for example, Xcode versions.

Example Request and Response

See Also

Getting macOS Version Information