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 CiBuildRuns API

The CiBuildRuns API from iOS — 6 operation(s) for cibuildruns.

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

Tagged areas include CiBuildRuns. 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 6 operations across 6 paths, and defines 70 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/.

6 operations 6 paths 70 schemas 5 GET1 POST

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 CiBuildRuns 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 6

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

CiBuildRuns 6
POST
/v1/ciBuildRuns
Create Ci Build Runs
ciBuildRuns_createInstance body → 400401403422201409429
GET
/v1/ciBuildRuns/{id}
Get Ci Build Runs
ciBuildRuns_getInstance 9 params → 400401403404200429
GET
/v1/ciBuildRuns/{id}/relationships/actions
List Related Ci Build Runs / Actions
ciBuildRuns_actions_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciBuildRuns/{id}/actions
List Related Ci Build Runs / Actions
ciBuildRuns_actions_getToManyRelated 5 params → 400401403404200429
GET
/v1/ciBuildRuns/{id}/relationships/builds
List Related Ci Build Runs / Builds
ciBuildRuns_builds_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciBuildRuns/{id}/builds
List Related Ci Build Runs / Builds
ciBuildRuns_builds_getToManyRelated 36 params → 400401403404200429

Schemas 70

The contract defines 70 schemas that model the data the API accepts and returns. The most detailed are CiAction (8 properties), ScmPullRequest (5 properties), BuildBundle (5 properties), AppEncryptionDeclaration (5 properties). Each schema is shown below with its type and property counts.

CiManualTagStartCondition
object
1 property
ImageAsset
object
3 properties
PagedDocumentLinks
object
3 properties 1 required
BetaAppReviewSubmission
object
5 properties 2 required
CiActionType
string
ResourceLinks
object
1 property
CiTagStartCondition
object
3 properties
ErrorSourceParameter
object
1 property 1 required
ErrorLinks
object
2 properties
ScmPullRequest
object
5 properties 2 required
StateDetail
object
2 properties
CiExecutionProgress
string
AppVersionState
string
CiAction
object
8 properties
BetaTester
object
5 properties 2 required
CiTestDestinationKind
string
BuildBetaDetail
object
5 properties 2 required
DocumentLinks
object
1 property 1 required
Platform
string
CiIssueCounts
object
4 properties
AppEncryptionDeclarationState
string
CiProduct
object
5 properties 2 required
BuildUpload
object
5 properties 2 required
BuildsResponse
object
4 properties 2 required
BuildIcon
object
4 properties 2 required
PrereleaseVersion
object
5 properties 2 required
CiBuildActionsResponse
object
4 properties 2 required
CiBuildRunCreateRequest
object
1 property 1 required
CiManualPullRequestStartCondition
object
2 properties
ErrorResponse
object
1 property
CiBuildAction
object
5 properties 2 required
BetaTesterState
string
CiTestDestination
object
5 properties
AppEncryptionDeclaration
object
5 properties 2 required
CiBuildRunResponse
object
3 properties 2 required
CiBuildRunBuildsLinkagesResponse
object
3 properties 2 required
App
object
5 properties 2 required
Build
object
5 properties 2 required
RelationshipLinks
object
2 properties
SubscriptionStatusUrlVersion
string
CiBuildRun
object
5 properties 2 required
CiManualBranchStartCondition
object
1 property
BetaInviteType
string
CiBuildRunActionsLinkagesResponse
object
3 properties 2 required
AppStoreVersionState
string
BuildBundle
object
5 properties 2 required
BuildUploadState
string
AppStoreVersion
object
5 properties 2 required
CiGitUser
object
2 properties
ErrorSourcePointer
object
1 property 1 required
PagingInformation
object
1 property 1 required
BetaBuildLocalization
object
5 properties 2 required
BuildAudienceType
string
CiStartConditionFileMatcher
object
3 properties
InternalBetaState
string
CiPullRequestStartCondition
object
4 properties
CiTagPatterns
object
2 properties
CiCompletionStatus
string
IconAssetType
string
BetaGroup
object
5 properties 2 required
ExternalBetaState
string
CiScheduledStartCondition
object
2 properties
CiWorkflow
object
5 properties 2 required
CiBranchPatterns
object
2 properties
ScmGitReference
object
5 properties 2 required
CiFilesAndFoldersRule
object
2 properties
BetaReviewState
string
CiGitRefKind
string
BuildBundleType
string
CiBranchStartCondition
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ios-cibuildruns-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