Adobe Cloud Manager API

swagger: '2.0'
info:
  version: 1.0.0
  title: Cloud Manager API
  description: 'This API allows access to Cloud Manager programs, pipelines, and environments by an authorized technical account created through the Adobe I/O Console. The base url for this API is https://cloudmanager.adobe.io, e.g. to get the list of programs for an organization, you would make a GET request to https://cloudmanager.adobe.io/api/programs (with the correct set of headers as described below). This swagger file can be downloaded from https://raw.githubusercontent.com/AdobeDocs/cloudmanager-api-docs/main/swagger-specs/api.yaml.'
host: cloudmanager.adobe.io
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
tags:
  - name: Programs
  - name: Repositories
  - name: Branches
  - name: Pipelines
  - name: Pipeline Execution
  - name: Execution Artifacts
  - name: Environments
  - name: Region Deployments
  - name: Variables
  - name: Rapid Development Environments
  - name: Environment Restore From Backup
  - name: IP Allowlist
  - name: IP Allowlist Binding
  - name: Domain
  - name: Domain Mappings - CDN Configurations
  - name: SSL Certificates
  - name: EDS Sites
  - name: Tenants
  - name: Regions
  - name: Network infrastructure
  - name: Environment Advanced Networking Configuration
  - name: ContentSets
paths:
  /api/programs:
    get:
      tags:
        - Programs
      summary: Lists Programs
      description: 'This API is deprecated and should no longer be used. Please use the [Lists Programs for Tenant API](#operation/getProgramsForTenant) instead.'
      operationId: getPrograms
      parameters:
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/ProgramList'
  '/api/program/{programId}':
    get:
      tags:
        - Programs
      summary: Get Program
      description: Returns a program by its id
      operationId: getProgram
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of program
          schema:
            $ref: '#/definitions/Program'
        '404':
          description: Program not found
    delete:
      tags:
        - Programs
      summary: Delete Program
      description: Delete an program
      operationId: deleteProgram
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Program'
        '202':
          description: Delete was successful.
          schema:
            $ref: '#/definitions/Program'
        '403':
          description: Forbidden.
        '404':
          description: Program not found.
        '412':
          description: Deletion not supported
  '/api/program/{programId}/repositories':
    get:
      tags:
        - Repositories
      summary: Lists Repositories
      description: Lists all Repositories in an program
      operationId: getRepositories
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: start
          in: query
          description: Pagination start parameter
          required: false
          type: string
          default: '0'
        - name: limit
          in: query
          description: Pagination limit parameter
          required: false
          type: integer
          default: 20
          format: int32
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/RepositoryList'
  '/api/program/{programId}/repository/{repositoryId}':
    get:
      tags:
        - Repositories
      summary: Get Repository
      description: Returns an repository by its id
      operationId: getRepository
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: repositoryId
          in: path
          description: Identifier of the repository
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Repository'
  '/api/program/{programId}/repository/{repositoryId}/branches':
    get:
      tags:
        - Branches
      summary: List Branches
      description: Returns the list of branches from a repository
      operationId: getBranches
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: repositoryId
          in: path
          description: Identifier of the repository
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of the list of repository branches
          schema:
            $ref: '#/definitions/BranchList'
  '/api/program/{programId}/pipelines':
    get:
      tags:
        - Pipelines
      summary: List Pipelines
      description: Returns all the pipelines that the requesting user has access to in an program
      operationId: getPipelines
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: type
          in: query
          description: Type of the pipelines
          required: false
          type: string
        - name: start
          in: query
          description: Pagination start parameter
          required: false
          type: string
          default: '0'
        - name: limit
          in: query
          description: Pagination limit parameter
          required: false
          type: integer
          default: 500
          format: int32
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/PipelineList'
  '/api/program/{programId}/pipeline/{pipelineId}':
    get:
      tags:
        - Pipelines
      summary: Get Pipeline
      description: Returns a pipeline by its id
      operationId: getPipeline
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of pipeline
          schema:
            $ref: '#/definitions/Pipeline'
        '404':
          description: Pipeline not found
    delete:
      tags:
        - Pipelines
      summary: Delete a Pipeline
      description: Delete a pipeline. All the data is wiped.
      operationId: deletePipeline
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        default:
          description: successful operation
    patch:
      tags:
        - Pipelines
      summary: Patches Pipeline
      description: Patches a pipeline within an program.
      operationId: patchPipeline
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - in: body
          name: body
          description: The update to the pipeline
          required: true
          schema:
            $ref: '#/definitions/PipelineUpdate'
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
        - name: Content-Type
          in: header
          description: Must always be application/json
          required: true
          type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Pipeline'
  '/api/program/{programId}/pipeline/{pipelineId}/cache':
    delete:
      tags:
        - Pipelines
      summary: Invalidate Cache
      description: Remove all cached artifacts and resets the cache to an empty state.
      operationId: invalidateCache
      parameters:
        - name: programId
          in: path
          description: Identifier of the program
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        default:
          description: successful operation
  '/api/program/{programId}/pipeline/{pipelineId}/execution':
    get:
      tags:
        - Pipeline Execution
      summary: Get current pipeline execution
      description: Returns current pipeline execution if any.
      operationId: getCurrentExecution
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of current execution
          schema:
            $ref: '#/definitions/PipelineExecution'
        '404':
          description: No pipeline execution exits or unknown pipeline or program
    put:
      tags:
        - Pipeline Execution
      summary: Start the pipeline
      description: Starts the Pipeline. This works only if the pipeline is not already started.
      operationId: startPipeline
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: pipelineExecutionMode
          in: query
          description: The mode in which to run the execution. EMERGENCY mode will skip certain steps and is only available to select AMS customers.
          required: false
          type: string
          default: NORMAL
          enum:
            - NORMAL
            - EMERGENCY
        - name: stepId
          in: query
          description: Identifier of the step from which the re-execution will start
          required: false
          type: string
        - name: sourceExecutionId
          in: query
          description: Identifier of the source execution from which the execution will start
          required: false
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
        - name: Content-Type
          in: header
          description: Must always be application/json
          required: true
          type: string
      responses:
        '201':
          description: Successfully started pipeline execution
          schema:
            $ref: '#/definitions/PipelineExecution'
          headers:
            location:
              type: string
              description: The URL of the new execution
        '400':
          description: Request conflicts with the expected state of pipeline
        '404':
          description: No pipeline execution exits or unknown pipeline or application
        '412':
          description: Pipeline is busy
        '503':
          description: Pipeline execution cannot be started because of unplanned maintenance
          schema:
            $ref: '#/definitions/SystemUnderMaintenanceExceptionMapper'
  '/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}':
    get:
      tags:
        - Pipeline Execution
      summary: Get pipeline execution
      description: Returns a pipeline execution by id
      operationId: getExecution
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: executionId
          in: path
          description: Identifier of the execution
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of execution
          schema:
            $ref: '#/definitions/PipelineExecution'
        '404':
          description: No pipeline execution exits or unknown pipeline or application
  '/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}':
    get:
      tags:
        - Pipeline Execution
      summary: Get step state
      description: ''
      operationId: stepState
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: executionId
          in: path
          description: Identifier of the execution
          required: true
          type: string
        - name: phaseId
          in: path
          description: Identifier of the phase
          required: true
          type: string
        - name: stepId
          in: path
          description: Identifier of the step
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of step state
          schema:
            $ref: '#/definitions/PipelineExecutionStepState'
        '403':
          description: Missing permission for user to read step
        '404':
          description: Pipeline execution does not exist
  '/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/advance':
    put:
      tags:
        - Pipeline Execution
      summary: Advance
      description: 'Post to this url in order to advance the current pipeline execution, if paused and waiting for user interaction. Link is present in output only in that case. The input depends on the actual reason for which the pipeline execution stopped.'
      operationId: advancePipelineExecution
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: executionId
          in: path
          description: Identifier of the execution
          required: true
          type: string
        - name: phaseId
          in: path
          description: Identifier of the phase
          required: true
          type: string
        - name: stepId
          in: path
          description: Identifier of the step
          required: true
          type: string
        - in: body
          name: body
          description: 'Input for advance. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.'
          required: true
          schema:
            type: object
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
        - name: Content-Type
          in: header
          description: Must always be application/json
          required: true
          type: string
      responses:
        '202':
          description: Successful resume of pipeline execution
        '403':
          description: Missing permission for user to advance the pipeline execution
        '404':
          description: No pipeline execution exits or unknown pipeline or program
  '/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/cancel':
    put:
      tags:
        - Pipeline Execution
      summary: Cancel
      description: Post to this url in order to cancel the current pipeline execution. Link is present in output only in that case.
      operationId: cancelPipelineExecutionStep
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: executionId
          in: path
          description: Identifier of the execution
          required: true
          type: string
        - name: phaseId
          in: path
          description: Identifier of the phase
          required: true
          type: string
        - name: stepId
          in: path
          description: Identifier of the step
          required: true
          type: string
        - in: body
          name: body
          description: 'Input for cancel. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.'
          required: true
          schema:
            type: object
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
        - name: Content-Type
          in: header
          description: Must always be application/json
          required: true
          type: string
      responses:
        '202':
          description: Successful cancel of pipeline execution
        '403':
          description: Missing permission for user to cancel the current pipeline execution
        '404':
          description: No pipeline execution exits or unknown pipeline or program
  '/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/logs':
    get:
      tags:
        - Pipeline Execution
      summary: Get logs
      description: Get the logs associated with a step.
      operationId: getStepLogs
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: executionId
          in: path
          description: Identifier of the execution
          required: true
          type: string
        - name: phaseId
          in: path
          description: Identifier of the phase
          required: true
          type: string
        - name: stepId
          in: path
          description: Identifier of the step
          required: true
          type: string
        - name: file
          in: query
          description: Identifier of the log file
          required: false
          type: string
        - name: Accept
          in: header
          required: false
          type: string
          description: 'Specify application/json in this header to receive a JSON response. Otherwise, a 307 response code will be returned with a Location header.'
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of logs
          schema:
            $ref: '#/definitions/Redirect'
        '403':
          description: Missing permission for user to read logs
        '404':
          description: Pipeline execution does not exist
  '/api/program/{programId}/pipeline/{pipelineId}/execution/{executionId}/phase/{phaseId}/step/{stepId}/artifacts':
    get:
      tags:
        - Execution Artifacts
      summary: ListArtifacts
      description: Get the list of artifacts associated with a step.
      operationId: listStepArtifacts
      parameters:
        - name: programId
          in: path
          description: Identifier of the program.
          required: true
          type: string
        - name: pipelineId
          in: path
          description: Identifier of the pipeline
          required: true
          type: string
        - name: executionId
          in: path
          description: Identifier of the execution
          required: true
          type: string
        - name: phaseId
          in: path
          description: Identifier of the phase
          required: true
          type: string
        - name: stepId
          in: path
          description: Identifier of the step
          required: true
          type: string
        - name: x-gw-ims-org-id
          in: header
          description: IMS organization ID that the request is being made under.
          required: true
          type: string
        - name: Authorization
          in: header
          description: 'Bearer [token] - An access token for the technical account created through integration with Adobe IO'
          required: true
          type: string
        - name: x-api-key
          in: header
          description: IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io
          required: true
          type: string
      responses:
        '200':
          description: Successful retrieval of artifacts list
          schema:
            $ref: '#/definitions/ArtifactList'
        '403':
          description: Missing permission for user to read artifacts
        '404':
          description: Pipeline execution does not exist
  '/api/program/{programId}/pipelin

# --- truncated at 32 KB (267 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-cloud-manager-openapi.yaml