iOS CiBuildActions API

openapi: 3.0.1
info:
  title: App Store Connect AccessibilityDeclarations CiBuildActions API
  version: 4.3.1
  x-platforms:
    app_store_connect_api: App Store Connect API
  description: The App Store Connect API is the standards-based REST API Apple provides to automate tasks across App Store Connect, Xcode, and Certificates, Identifiers & Profiles. It covers apps, builds, TestFlight, in-app purchases, subscriptions, Game Center, Xcode Cloud, provisioning, pricing and availability, and the full reporting surface (analytics, sales and trends, financial reports, power and performance). This spec is the official OpenAPI 3.0 document published by Apple at https://developer.apple.com/app-store-connect/api/ — mirrored here unmodified except for title-cased operation summaries.
servers:
- url: https://api.appstoreconnect.apple.com/
security:
- itc-bearer-token: []
tags:
- name: CiBuildActions
paths:
  /v1/ciBuildActions/{id}:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_getInstance
      parameters:
      - name: fields[ciBuildActions]
        in: query
        description: the fields to include for returned resources of type ciBuildActions
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - actionType
            - startedDate
            - finishedDate
            - issueCounts
            - executionProgress
            - completionStatus
            - isRequiredToPass
            - buildRun
            - artifacts
            - issues
            - testResults
        style: form
        explode: false
        required: false
      - name: fields[ciBuildRuns]
        in: query
        description: the fields to include for returned resources of type ciBuildRuns
        schema:
          type: array
          items:
            type: string
            enum:
            - number
            - createdDate
            - startedDate
            - finishedDate
            - sourceCommit
            - destinationCommit
            - isPullRequestBuild
            - issueCounts
            - executionProgress
            - completionStatus
            - startReason
            - cancelReason
            - builds
            - workflow
            - product
            - sourceBranchOrTag
            - destinationBranch
            - actions
            - pullRequest
        style: form
        explode: false
        required: false
      - name: include
        in: query
        description: comma-separated list of relationships to include
        schema:
          type: array
          items:
            type: string
            enum:
            - buildRun
        style: form
        explode: false
        required: false
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single CiBuildAction
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiBuildActionResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Ci Build Actions
  /v1/ciBuildActions/{id}/relationships/artifacts:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_artifacts_getToManyRelationship
      parameters:
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of related linkages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiBuildActionArtifactsLinkagesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Ci Build Actions / Artifacts
  /v1/ciBuildActions/{id}/artifacts:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_artifacts_getToManyRelated
      parameters:
      - name: fields[ciArtifacts]
        in: query
        description: the fields to include for returned resources of type ciArtifacts
        schema:
          type: array
          items:
            type: string
            enum:
            - fileType
            - fileName
            - fileSize
            - downloadUrl
        style: form
        explode: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of CiArtifacts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiArtifactsResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Ci Build Actions / Artifacts
  /v1/ciBuildActions/{id}/relationships/buildRun:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_buildRun_getToOneRelationship
      parameters: []
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Related linkage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiBuildActionBuildRunLinkageResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Related Ci Build Actions / Build Run
  /v1/ciBuildActions/{id}/buildRun:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_buildRun_getToOneRelated
      parameters:
      - name: fields[ciBuildRuns]
        in: query
        description: the fields to include for returned resources of type ciBuildRuns
        schema:
          type: array
          items:
            type: string
            enum:
            - number
            - createdDate
            - startedDate
            - finishedDate
            - sourceCommit
            - destinationCommit
            - isPullRequestBuild
            - issueCounts
            - executionProgress
            - completionStatus
            - startReason
            - cancelReason
            - builds
            - workflow
            - product
            - sourceBranchOrTag
            - destinationBranch
            - actions
            - pullRequest
        style: form
        explode: false
      - name: fields[builds]
        in: query
        description: the fields to include for returned resources of type builds
        schema:
          type: array
          items:
            type: string
            enum:
            - version
            - uploadedDate
            - expirationDate
            - expired
            - minOsVersion
            - lsMinimumSystemVersion
            - computedMinMacOsVersion
            - computedMinVisionOsVersion
            - iconAssetToken
            - processingState
            - buildAudienceType
            - usesNonExemptEncryption
            - preReleaseVersion
            - individualTesters
            - betaGroups
            - betaBuildLocalizations
            - appEncryptionDeclaration
            - betaAppReviewSubmission
            - app
            - buildBetaDetail
            - appStoreVersion
            - icons
            - buildBundles
            - buildUpload
            - perfPowerMetrics
            - diagnosticSignatures
        style: form
        explode: false
      - name: fields[ciWorkflows]
        in: query
        description: the fields to include for returned resources of type ciWorkflows
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - description
            - branchStartCondition
            - tagStartCondition
            - pullRequestStartCondition
            - scheduledStartCondition
            - manualBranchStartCondition
            - manualTagStartCondition
            - manualPullRequestStartCondition
            - actions
            - isEnabled
            - isLockedForEditing
            - clean
            - containerFilePath
            - lastModifiedDate
            - product
            - repository
            - xcodeVersion
            - macOsVersion
            - buildRuns
        style: form
        explode: false
      - name: fields[ciProducts]
        in: query
        description: the fields to include for returned resources of type ciProducts
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - createdDate
            - productType
            - app
            - bundleId
            - workflows
            - primaryRepositories
            - additionalRepositories
            - buildRuns
        style: form
        explode: false
      - name: fields[scmGitReferences]
        in: query
        description: the fields to include for returned resources of type scmGitReferences
        schema:
          type: array
          items:
            type: string
            enum:
            - name
            - canonicalName
            - isDeleted
            - kind
            - repository
        style: form
        explode: false
      - name: fields[scmPullRequests]
        in: query
        description: the fields to include for returned resources of type scmPullRequests
        schema:
          type: array
          items:
            type: string
            enum:
            - title
            - number
            - webUrl
            - sourceRepositoryOwner
            - sourceRepositoryName
            - sourceBranchName
            - destinationRepositoryOwner
            - destinationRepositoryName
            - destinationBranchName
            - isClosed
            - isCrossRepository
            - repository
        style: form
        explode: false
      - name: include
        in: query
        description: comma-separated list of relationships to include
        schema:
          type: array
          items:
            type: string
            enum:
            - builds
            - workflow
            - product
            - sourceBranchOrTag
            - destinationBranch
            - pullRequest
        style: form
        explode: false
      - name: limit[builds]
        in: query
        description: maximum number of related builds returned (when they are included)
        schema:
          type: integer
          maximum: 50
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Single CiBuildRun
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiBuildRunResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: Get Related Ci Build Actions / Build Run
  /v1/ciBuildActions/{id}/relationships/issues:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_issues_getToManyRelationship
      parameters:
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of related linkages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiBuildActionIssuesLinkagesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Ci Build Actions / Issues
  /v1/ciBuildActions/{id}/issues:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_issues_getToManyRelated
      parameters:
      - name: fields[ciIssues]
        in: query
        description: the fields to include for returned resources of type ciIssues
        schema:
          type: array
          items:
            type: string
            enum:
            - issueType
            - message
            - fileSource
            - category
        style: form
        explode: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of CiIssues
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiIssuesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Ci Build Actions / Issues
  /v1/ciBuildActions/{id}/relationships/testResults:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_testResults_getToManyRelationship
      parameters:
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of related linkages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiBuildActionTestResultsLinkagesResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Ci Build Actions / Test Results
  /v1/ciBuildActions/{id}/testResults:
    parameters:
    - name: id
      in: path
      description: the id of the requested resource
      schema:
        type: string
      style: simple
      required: true
    get:
      tags:
      - CiBuildActions
      operationId: ciBuildActions_testResults_getToManyRelated
      parameters:
      - name: fields[ciTestResults]
        in: query
        description: the fields to include for returned resources of type ciTestResults
        schema:
          type: array
          items:
            type: string
            enum:
            - className
            - name
            - status
            - fileSource
            - message
            - destinationTestResults
        style: form
        explode: false
      - name: limit
        in: query
        description: maximum resources per page
        schema:
          type: integer
          maximum: 200
        style: form
      responses:
        '400':
          description: Parameter error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized error(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: List of CiTestResults
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CiTestResultsResponse'
        '429':
          description: Rate limit exceeded error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      summary: List Related Ci Build Actions / Test Results
components:
  schemas:
    CiBuildActionTestResultsLinkagesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - ciTestResults
              id:
                type: string
            required:
            - id
            - type
        links:
          $ref: '#/components/schemas/PagedDocumentLinks'
        meta:
          $ref: '#/components/schemas/PagingInformation'
      required:
      - data
      - links
    CiManualTagStartCondition:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/CiTagPatterns'
    ImageAsset:
      type: object
      properties:
        templateUrl:
          type: string
        width:
          type: integer
        height:
          type: integer
    PagedDocumentLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
        first:
          type: string
          format: uri-reference
        next:
          type: string
          format: uri-reference
      required:
      - self
    CiTestResultsResponse:
      type: object
      title: CiTestResultsResponse
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CiTestResult'
        links:
          $ref: '#/components/schemas/PagedDocumentLinks'
        meta:
          $ref: '#/components/schemas/PagingInformation'
      required:
      - data
      - links
    CiActionType:
      type: string
      enum:
      - BUILD
      - ANALYZE
      - TEST
      - ARCHIVE
    ResourceLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
    CiTagStartCondition:
      type: object
      properties:
        source:
          $ref: '#/components/schemas/CiTagPatterns'
        filesAndFoldersRule:
          $ref: '#/components/schemas/CiFilesAndFoldersRule'
        autoCancel:
          type: boolean
    ErrorSourceParameter:
      type: object
      title: Parameter
      properties:
        parameter:
          type: string
      required:
      - parameter
    ErrorLinks:
      type: object
      properties:
        about:
          type: string
          format: uri-reference
        associated:
          oneOf:
          - type: string
            format: uri-reference
          - type: object
            properties:
              href:
                type: string
                format: uri-reference
              meta:
                type: object
                properties:
                  source:
                    type: string
    ScmPullRequest:
      type: object
      title: ScmPullRequest
      properties:
        type:
          type: string
          enum:
          - scmPullRequests
        id:
          type: string
        attributes:
          type: object
          properties:
            title:
              type: string
            number:
              type: integer
            webUrl:
              type: string
              format: uri
            sourceRepositoryOwner:
              type: string
            sourceRepositoryName:
              type: string
            sourceBranchName:
              type: string
            destinationRepositoryOwner:
              type: string
            destinationRepositoryName:
              type: string
            destinationBranchName:
              type: string
            isClosed:
              type: boolean
            isCrossRepository:
              type: boolean
        relationships:
          type: object
          properties:
            repository:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - scmRepositories
                    id:
                      type: string
                  required:
                  - id
                  - type
        links:
          $ref: '#/components/schemas/ResourceLinks'
      required:
      - id
      - type
    CiExecutionProgress:
      type: string
      enum:
      - PENDING
      - RUNNING
      - COMPLETE
    FileLocation:
      type: object
      properties:
        path:
          type: string
        lineNumber:
          type: integer
    CiAction:
      type: object
      properties:
        name:
          type: string
        actionType:
          $ref: '#/components/schemas/CiActionType'
        destination:
          type: string
          enum:
          - ANY_IOS_DEVICE
          - ANY_IOS_SIMULATOR
          - ANY_TVOS_DEVICE
          - ANY_TVOS_SIMULATOR
          - ANY_WATCHOS_DEVICE
          - ANY_WATCHOS_SIMULATOR
          - ANY_MAC
          - ANY_MAC_CATALYST
          - ANY_VISIONOS_DEVICE
          - ANY_VISIONOS_SIMULATOR
        buildDistributionAudience:
          $ref: '#/components/schemas/BuildAudienceType'
        testConfiguration:
          type: object
          properties:
            kind:
              type: string
              enum:
              - USE_SCHEME_SETTINGS
              - SPECIFIC_TEST_PLANS
            testPlanName:
              type: string
            testDestinations:
              type: array
              items:
                $ref: '#/components/schemas/CiTestDestination'
        scheme:
          type: string
        platform:
          type: string
          enum:
          - MACOS
          - IOS
          - TVOS
          - WATCHOS
          - VISIONOS
        isRequiredToPass:
          type: boolean
    CiTestDestinationKind:
      type: string
      enum:
      - SIMULATOR
      - MAC
    DocumentLinks:
      type: object
      properties:
        self:
          type: string
          format: uri-reference
      required:
      - self
    CiIssueCounts:
      type: object
      properties:
        analyzerWarnings:
          type: integer
        errors:
          type: integer
        testFailures:
          type: integer
        warnings:
          type: integer
    CiArtifactsResponse:
      type: object
      title: CiArtifactsResponse
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CiArtifact'
        links:
          $ref: '#/components/schemas/PagedDocumentLinks'
        meta:
          $ref: '#/components/schemas/PagingInformation'
      required:
      - data
      - links
    CiProduct:
      type: object
      title: CiProduct
      properties:
        type:
          type: string
          enum:
          - ciProducts
        id:
          type: string
        attributes:
          type: object
          properties:
            name:
              type: string
            createdDate:
              type: string
              format: date-time
            productType:
              type: string
              enum:
              - APP
              - FRAMEWORK
        relationships:
          type: object
          properties:
            app:
              type: object
              properties:
                links:
                  $ref: '#/components/schemas/RelationshipLinks'
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - apps
                    id:
                      type: string
                  required:
                  - id
                  - type
            bundleId:
              type: object
              properties:
                data:
                  type: object
                  properties:
                    type:
                      type: string
                      enum:
                      - bundleIds
                    id:
                      type: string
                  required:
                  - id
                  - type
            workflows:
              type: object
              properties:
                links:
                  $ref: '#/components/schemas/RelationshipLinks'
            primaryRepositories:
              type: object
              properties:
                links:
                  $ref: '#/components/schemas/RelationshipLinks'
                meta:
                  $ref: '#/components/schemas/PagingInformation'
                data:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                        - scmRepositories
                      id:
                        type: string
                    required:
                    - id
                    - type
            additionalRepositories:
              type: object
              properties:
        

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ios/refs/heads/main/openapi/ios-cibuildactions-api-openapi.yml