Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

iOS CiMacOsVersions API

The CiMacOsVersions API from iOS — 4 operation(s) for cimacosversions.

iOS CiMacOsVersions API is one of 199 APIs that iOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CiMacOsVersions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and release notes.

This API exposes 4 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.0.1, at version 4.3.1.

Requests are made against a single base URL, https://api.appstoreconnect.apple.com/.

4 operations 4 paths 16 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
4.3.1
Base URL
https://api.appstoreconnect.apple.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

iOS CiMacOsVersions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (itc-bearer-token). By default, every request must be authenticated.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

CiMacOsVersions 4
GET
/v1/ciMacOsVersions
List Ci Mac OS Versions
ciMacOsVersions_getCollection 5 params → 400401403200429
GET
/v1/ciMacOsVersions/{id}
Get Ci Mac OS Versions
ciMacOsVersions_getInstance 5 params → 400401403404200429
GET
/v1/ciMacOsVersions/{id}/relationships/xcodeVersions
List Related Ci Mac OS Versions / Xcode Versions
ciMacOsVersions_xcodeVersions_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciMacOsVersions/{id}/xcodeVersions
List Related Ci Mac OS Versions / Xcode Versions
ciMacOsVersions_xcodeVersions_getToManyRelated 6 params → 400401403404200429

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are CiMacOsVersion (5 properties), CiXcodeVersion (5 properties), CiMacOsVersionsResponse (4 properties), CiXcodeVersionsResponse (4 properties). Each schema is shown below with its type and property counts.

DocumentLinks
object
1 property 1 required
RelationshipLinks
object
2 properties
PagedDocumentLinks
object
3 properties 1 required
ResourceLinks
object
1 property
CiXcodeVersionsResponse
object
4 properties 2 required
CiTestDestinationKind
string
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
CiMacOsVersionXcodeVersionsLinkagesResponse
object
3 properties 2 required
CiXcodeVersion
object
5 properties 2 required
ErrorResponse
object
1 property
CiMacOsVersionsResponse
object
4 properties 2 required
ErrorSourcePointer
object
1 property 1 required
CiMacOsVersionResponse
object
3 properties 2 required
PagingInformation
object
1 property 1 required
CiMacOsVersion
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-cimacosversions-api-openapi.yml Raw ↑

Other APIs iOS publishes across the network.

App Store Server API
App Store Server Notifications
Apple Push Notification Service (APNs)
DeviceCheck and App Attest
Sign in with Apple REST API
Apple Music API
Wallet / PassKit Web Service
iOS AccessibilityDeclarations API
iOS Actors API
iOS AgeRatingDeclarations API
iOS AlternativeDistributionDomains API
iOS AlternativeDistributionKeys API