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

The CiWorkflows API from iOS — 6 operation(s) for ciworkflows.

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

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

8 operations 6 paths 49 schemas 1 DELETE5 GET1 PATCH1 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 CiWorkflows 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 8

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

CiWorkflows 8
POST
/v1/ciWorkflows
Create Ci Workflows
ciWorkflows_createInstance body → 400401403422201409429
GET
/v1/ciWorkflows/{id}
Get Ci Workflows
ciWorkflows_getInstance 7 params → 400401403404200429
PATCH
/v1/ciWorkflows/{id}
Update Ci Workflows
ciWorkflows_updateInstance 1 param body → 400401403404422200409429
DELETE
/v1/ciWorkflows/{id}
Delete Ci Workflows
ciWorkflows_deleteInstance 1 param → 400401403404204429
GET
/v1/ciWorkflows/{id}/relationships/buildRuns
List Related Ci Workflows / Build Runs
ciWorkflows_buildRuns_getToManyRelationship 2 params → 400401403404200429
GET
/v1/ciWorkflows/{id}/buildRuns
List Related Ci Workflows / Build Runs
ciWorkflows_buildRuns_getToManyRelated 12 params → 400401403404200429
GET
/v1/ciWorkflows/{id}/relationships/repository
Get Related Ci Workflows / Repository
ciWorkflows_repository_getToOneRelationship 1 param → 400401403404200429
GET
/v1/ciWorkflows/{id}/repository
Get Related Ci Workflows / Repository
ciWorkflows_repository_getToOneRelated 5 params → 400401403404200429

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are CiAction (8 properties), ScmProvider (5 properties), CiWorkflow (5 properties), CiMacOsVersion (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
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
CiXcodeVersion
object
5 properties 2 required
CiExecutionProgress
string
CiAction
object
8 properties
CiTestDestinationKind
string
DocumentLinks
object
1 property 1 required
CiIssueCounts
object
4 properties
CiProduct
object
5 properties 2 required
CiWorkflowBuildRunsLinkagesResponse
object
3 properties 2 required
CiManualPullRequestStartCondition
object
2 properties
ErrorResponse
object
1 property
CiTestDestination
object
5 properties
CiWorkflowResponse
object
3 properties 2 required
CiMacOsVersion
object
5 properties 2 required
CiBuildRunsResponse
object
4 properties 2 required
ScmProvider
object
5 properties 2 required
Build
object
5 properties 2 required
RelationshipLinks
object
2 properties
ScmRepository
object
5 properties 2 required
CiBuildRun
object
5 properties 2 required
CiWorkflowCreateRequest
object
1 property 1 required
CiManualBranchStartCondition
object
1 property
ScmRepositoryResponse
object
3 properties 2 required
CiGitUser
object
2 properties
CiWorkflowRepositoryLinkageResponse
object
2 properties 2 required
ErrorSourcePointer
object
1 property 1 required
ScmProviderType
object
3 properties
PagingInformation
object
1 property 1 required
BuildAudienceType
string
CiWorkflowUpdateRequest
object
1 property 1 required
CiStartConditionFileMatcher
object
3 properties
CiPullRequestStartCondition
object
4 properties
CiTagPatterns
object
2 properties
CiCompletionStatus
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
CiGitRefKind
string
CiBranchStartCondition
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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