Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Adobe Suite Environments API
version: '1.0'
description: 'Operations tagged Environments across 2 of this provider''s published API definitions: adobe-suite-aep-reactor-openapi.yaml, adobe-suite-cloud-manager-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: //reactor.adobe.io
- url: https://cloudmanager.adobe.io
tags:
- name: Environments
description: An environment indicates the specific host where a build can be deployed, and whether the build should be deployed as a set of files or compressed in an archive format. In the Reactor API, environments are separate from hosts themselves, which are managed by the /hosts endpoint.
paths:
/properties/{PROPERTY_ID}/environments:
get:
tags:
- Environments
summary: List a property's environments
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: listEnvironments
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property whose environments you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: name
in: query
description: Filter by `name`.
schema:
type: string
- name: stage
in: query
description: Filter by `stage`.
schema:
type: string
- name: token
in: query
description: Filter by `token`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns an array of environments belonging to the specified property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsListResponse'
post:
tags:
- Environments
summary: Create an environment
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: createEnvironment
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property that you want to create an environment for.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsCreateResponse'
x-codegen-request-body-name: body
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}:
get:
tags:
- Environments
summary: Retrieve an environment
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: retrieveEnvironment
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsLookupResponse'
delete:
tags:
- Environments
summary: Delete an environment
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: deleteEnvironment
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment you want to delete.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
responses:
'204':
x-summary: No content
description: A successful response returns HTTP status 204 (No Content).
content: {}
patch:
tags:
- Environments
summary: Update an environment
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: updateEnvironment
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment you want to update.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsUpdatePayload'
required: true
responses:
'200':
x-summary: Success
description: A successful response returns the details of the updated environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsUpdateResponse'
x-codegen-request-body-name: body
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}/builds:
get:
tags:
- Environments
summary: List an environment's builds
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: listBuilds
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose related builds you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
responses:
'200':
x-summary: Success
description: A successful response returns an array of builds that use the specified environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsBuildsListResponse'
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}/secrets:
get:
tags:
- Environments
summary: List an environment's secrets
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: listEnvironmentSecrets
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose related secrets you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
responses:
'200':
x-summary: Success
description: A successful response returns an array of secrets that are associated with the specified environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsSecretsListResponse'
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}/host:
get:
tags:
- Environments
summary: Retrieve a host
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: retrieveEnvironmentHost
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose host you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the environment's associated host.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsHostLookupResponse'
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}/relationships/host:
get:
tags:
- Environments
summary: Retrieve the host relationship for an environment
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: retrieveHostRelationship
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose host relationship you want to retrieve.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the host relationship for the specified environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsHostRelationshipLookupResponse'
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}/library:
get:
tags:
- Environments
summary: Retrieve an environment's related library
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: retrieveEnvironmentLibrary
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose related library you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the environment's associated library.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsLibraryLookupResponse'
servers:
- url: //reactor.adobe.io
/environments/{ENVIRONMENT_ID}/property:
get:
tags:
- Environments
summary: Retrieve the property that owns an environment
description: '>**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League.'
operationId: retrieveEnvironmentProperty
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose related property you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the environment's associated property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsPropertyLookupResponse'
servers:
- url: //reactor.adobe.io
/api/program/{programId}/environments:
get:
tags:
- Environments
summary: List Environments
description: Lists all environments in an program
operationId: getEnvironments
parameters:
- name: programId
in: path
description: Identifier of the program
required: true
schema:
type: string
- name: type
in: query
description: Type of the environment
required: false
schema:
type: string
enum:
- dev
- stage
- prod
- rde
- preprod
- name: x-gw-ims-org-id
in: header
description: IMS organization ID that the request is being made under.
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer [token] - An access token for the technical account created through integration with Adobe IO
required: true
schema:
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
schema:
type: string
responses:
'200':
description: Successful retrieval of environment list
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentList'
'404':
description: Program not found
post:
tags:
- Environments
summary: Create or clone Environment
description: Create Environment
operationId: createEnvironment
parameters:
- name: programId
in: path
description: Identifier of the program
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: IMS organization ID that the request is being made under.
required: true
schema:
type: string
- name: Authorization
in: header
description: Bearer [token] - An access token for the technical account created through integration with Adobe IO
required: true
schema:
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
schema:
type: string
- name: Content-Type
in: header
description: Must always be application/json
required: true
schema:
type: string
responses:
'201':
description: Environment created
content:
application/json:
schema:
$ref: '#/components/schemas/Environment'
'400':
description: Bad request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewEnvironment'
description: Environment
required: true
servers:
- url: https://cloudmanager.adobe.io
/api/program/{programId}/environment/{environmentId}:
get:
tags:
- Environments
summary: Get Environment
description: Returns an environment by its id
operationId: getEnvironment
parameters:
- name: programId
in: path
description: Identifier of the program
required: true
schema:
type: string
- name: environmentId
in: path
description: Identifier of the environmen
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-environments-api-openapi.yml