redocly logoAPI docs by Redocly

Cloud Manager API (1.0.0)

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.

Programs

Lists Programs

This API is deprecated and should no longer be used. Please use the Lists Programs for Tenant API instead.

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Get Program

Returns a program by its id

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "14",
  • "name": "AcmeCorp Main Site",
  • "enabled": false,
  • "tenantId": "acmeCorp",
  • "imsOrgId": "6522A55453334E247F120101@AdobeOrg",
  • "status": "creating",
  • "type": "aem_cloud_service",
  • "capabilities": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete Program

Delete an program

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "14",
  • "name": "AcmeCorp Main Site",
  • "enabled": false,
  • "tenantId": "acmeCorp",
  • "imsOrgId": "6522A55453334E247F120101@AdobeOrg",
  • "status": "creating",
  • "type": "aem_cloud_service",
  • "capabilities": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Post feedback

Add new feedback

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Feedback

createdAt
string

Created time

id
integer

Identifier of the feedback. Unique within the space.

rating
required
integer

Rating values from 1 to 5

comment
string

Feedback comment

type
required
string
Value: "GO_LIVE"

Type of feedback

options
object

Optional information about the feedback

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": 0,
  • "rating": 0,
  • "comment": "string",
  • "type": "GO_LIVE",
  • "options": { }
}

Get New Relic Sub Account users list

Get New Relic Sub Account users list for this program

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfNewRelicSubAccountUsers": 0,
  • "applicationId": "44",
  • "_embedded": {
    },
  • "_links": {
    }
}

Create and Delete New Relic Sub Account users

Create and Delete New Relic Sub Account users for this program

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

New Relic Sub-Account Users

id
string

Identifier of the New Relic sub account User

firstName
string

First name of the New Relic sub account User

lastName
string

Last name of the New Relic sub account User

email
string

email of the New Relic sub account user

role
string

Role of the New Relic sub account user

owner
boolean
Default: false

Owner detail of the New Relic sub account User

Responses

Request samples

Content type
application/json
{
  • "id": "42",
  • "firstName": "John",
  • "lastName": "Doe",
  • "email": "foobar@newrelic.com",
  • "role": "admin",
  • "owner": false
}

Response samples

Content type
application/json
{
  • "_totalNumberOfNewRelicSubAccountUsers": 0,
  • "applicationId": "44",
  • "_embedded": {
    },
  • "_links": {
    }
}

Lists Programs for Tenant

Returns all programs defined for tenant.

path Parameters
tenantId
required
string

Identifier of the tenant

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Create Program

Creates a program

path Parameters
tenantId
required
string

Identifier of the tenant

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Program

name
required
string [ 0 .. 64 ] characters

New program name

type
required
string
Value: "aem_cloud_service"
object (ProgramCapabilities)

Contains the program capabilities

solutionNames
Array of strings
Items Enum: "aemsites" "aemassets"

List of solutions to be enabled on the new program.

object (GoLiveDates)

Contains planned and actual go live dates of a program

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "aem_cloud_service",
  • "capabilities": { },
  • "solutionNames": [
    ],
  • "goLive": {
    }
}

Response samples

Content type
application/json
{
  • "id": "14",
  • "name": "AcmeCorp Main Site",
  • "enabled": false,
  • "tenantId": "acmeCorp",
  • "imsOrgId": "6522A55453334E247F120101@AdobeOrg",
  • "status": "creating",
  • "type": "aem_cloud_service",
  • "capabilities": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Repositories

Lists Repositories

Lists all Repositories in an program

path Parameters
programId
required
string

Identifier of the program

query Parameters
start
string
Default: "0"

Pagination start parameter

limit
integer <int32>
Default: 20

Pagination limit parameter

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Get Repository

Returns an repository by its id

path Parameters
programId
required
string

Identifier of the program

repositoryId
required
string

Identifier of the repository

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "repo": "Adobe-Marketing-Cloud",
  • "description": "Description",
  • "repositoryUrl": "https://git.cloudmanager.adobe.com/weretailprod/we-retail-global",
  • "_links": {
    }
}

Branches

List Branches

Returns the list of branches from a repository

path Parameters
programId
required
string

Identifier of the program.

repositoryId
required
string

Identifier of the repository

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Pipelines

List Pipelines

Returns all the pipelines that the requesting user has access to in an program

path Parameters
programId
required
string

Identifier of the program

query Parameters
type
string

Type of the pipelines

start
string
Default: "0"

Pagination start parameter

limit
integer <int32>
Default: 500

Pagination limit parameter

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Get Pipeline

Returns a pipeline by its id

path Parameters
programId
required
string

Identifier of the program

pipelineId
required
string

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "29",
  • "programId": "14",
  • "name": "AcmeCorp Main Pipeline",
  • "trigger": "MANUAL",
  • "status": "IDLE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastStartedAt": "2019-08-24T14:15:22Z",
  • "lastFinishedAt": "2019-08-24T14:15:22Z",
  • "phases": [
    ],
  • "type": "CI_CD",
  • "_links": {
    }
}

Delete a Pipeline

Delete a pipeline. All the data is wiped.

path Parameters
programId
required
string

Identifier of the program

pipelineId
required
string

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Patches Pipeline

Patches a pipeline within an program.

path Parameters
programId
required
string

Identifier of the program

pipelineId
required
string

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

The update to the pipeline

Array of objects (PipelinePhaseUpdate)

Pipeline phases to update

Responses

Request samples

Content type
application/json
{
  • "phases": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "29",
  • "programId": "14",
  • "name": "AcmeCorp Main Pipeline",
  • "trigger": "MANUAL",
  • "status": "IDLE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastStartedAt": "2019-08-24T14:15:22Z",
  • "lastFinishedAt": "2019-08-24T14:15:22Z",
  • "phases": [
    ],
  • "type": "CI_CD",
  • "_links": {
    }
}

Invalidate Cache

Remove all cached artifacts and resets the cache to an empty state.

path Parameters
programId
required
string

Identifier of the program

pipelineId
required
string

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Pipeline Execution

Get current pipeline execution

Returns current pipeline execution if any.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "pipelineId": "10",
  • "artifactsVersion": "string",
  • "user": "0123456789ABCDE@AdobeID",
  • "status": "NOT_STARTED",
  • "trigger": "ON_COMMIT",
  • "pipelineExecutionMode": "NORMAL",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "pipelineType": "CI_CD",
  • "_embedded": {
    },
  • "_links": {
    }
}

Start the pipeline

Starts the Pipeline. This works only if the pipeline is not already started.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

query Parameters
pipelineExecutionMode
string
Default: "NORMAL"
Enum: "NORMAL" "EMERGENCY"

The mode in which to run the execution. EMERGENCY mode will skip certain steps and is only available to select AMS customers.

stepId
string

Identifier of the step from which the re-execution will start

sourceExecutionId
string

Identifier of the source execution from which the execution will start

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "pipelineId": "10",
  • "artifactsVersion": "string",
  • "user": "0123456789ABCDE@AdobeID",
  • "status": "NOT_STARTED",
  • "trigger": "ON_COMMIT",
  • "pipelineExecutionMode": "NORMAL",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "pipelineType": "CI_CD",
  • "_embedded": {
    },
  • "_links": {
    }
}

Get pipeline execution

Returns a pipeline execution by id

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "pipelineId": "10",
  • "artifactsVersion": "string",
  • "user": "0123456789ABCDE@AdobeID",
  • "status": "NOT_STARTED",
  • "trigger": "ON_COMMIT",
  • "pipelineExecutionMode": "NORMAL",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "pipelineType": "CI_CD",
  • "_embedded": {
    },
  • "_links": {
    }
}

Get step state

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "stepId": "string",
  • "phaseId": "string",
  • "action": "build",
  • "repository": "string",
  • "branch": "string",
  • "environment": "string",
  • "environmentId": "string",
  • "environmentType": "string",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "finishedAt": "2019-08-24T14:15:22Z",
  • "commitId": "string",
  • "details": {
    },
  • "status": "NOT_STARTED",
  • "_links": {
    }
}

Advance

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.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Input for advance. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.

object

Responses

Request samples

Content type
application/json
{ }

Cancel

Post to this url in order to cancel the current pipeline execution. Link is present in output only in that case.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Input for cancel. See documentation at https://www.adobe.io/experience-cloud/cloud-manager/guides/api-usage/advancing-and-cancelling-steps/ for details.

object

Responses

Request samples

Content type
application/json
{ }

Get logs

Get the logs associated with a step.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

query Parameters
file
string

Identifier of the log file

header Parameters
Accept
string

Specify application/json in this header to receive a JSON response. Otherwise, a 307 response code will be returned with a Location header.

x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "redirect": "string"
}

Get step metrics

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "metrics": [
    ]
}

List Executions

Returns the history of pipeline executions in a newest to oldest order

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

query Parameters
start
string

Pagination start parameter

limit
integer <int32>

Pagination limit parameter

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Execution Artifacts

ListArtifacts

Get the list of artifacts associated with a step.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

GetArtifact

Get artifact.

path Parameters
programId
required
string

Identifier of the program.

pipelineId
required
string

Identifier of the pipeline

executionId
required
string

Identifier of the execution

phaseId
required
string

Identifier of the phase

stepId
required
string

Identifier of the step

artifactId
required
string

Identifier of the artifact

header Parameters
Accept
string
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Environments

List Environments

Lists all environments in an program

path Parameters
programId
required
string

Identifier of the program

query Parameters
type
string
Enum: "dev" "stage" "prod" "rde" "preprod"

Type of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Create or clone Environment

Create Environment

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Environment

name
required
string

Name of the environment

type
required
string
Enum: "dev" "stage" "prod" "rde"
region
required
string

Region to create the environment.

description
string

Description of the environment

Responses

Request samples

Content type
application/json
{
  • "name": "acme-dev1",
  • "type": "dev",
  • "region": "va7",
  • "description": "This is our primary development environment"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "name": "AcmeCorp Dev1 Environment",
  • "description": "This is our primary development environment",
  • "type": "dev",
  • "status": "creating",
  • "region": "va7",
  • "availableLogOptions": [
    ],
  • "_links": {
    }
}

Get Environment

Returns an environment by its id

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "name": "AcmeCorp Dev1 Environment",
  • "description": "This is our primary development environment",
  • "type": "dev",
  • "status": "creating",
  • "region": "va7",
  • "availableLogOptions": [
    ],
  • "_links": {
    }
}

DeleteEnvironment

Delete environment

path Parameters
programId
required
string

Identifier of the application

environmentId
required
string

Identifier of the environment

query Parameters
ignoreResourcesDeletionResult
boolean
Default: false

Ignore Resources Deletion Result option, delete flow does not fail if resources could not be deleted

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "name": "AcmeCorp Dev1 Environment",
  • "description": "This is our primary development environment",
  • "type": "dev",
  • "status": "creating",
  • "region": "va7",
  • "availableLogOptions": [
    ],
  • "_links": {
    }
}

Get Environment Logs

List all logs available in environment

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

query Parameters
service
required
Array of strings

Names of services

name
required
Array of strings

Names of log

days
required
integer <int32>

number of days for which logs are required

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "service": "author",
  • "name": "aemerror",
  • "days": 2,
  • "_links": {
    },
  • "_embedded": {
    }
}

Download Logs

Download environment logs

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

query Parameters
service
required
string

Name of service

name
required
string

Name of log

date
required
string <date>

date for which log is required

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Accept
string

Specify application/json in this header to receive a JSON response. Otherwise, a 307 response code will be returned with a Location header.

Responses

Response samples

Content type
application/json
{
  • "redirect": "string"
}

Region Deployments

Get Region Deployment

Return a region deployment by its id

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

regionDeploymentId
required
string

Identifier of the regionDeployment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "cluster": "ethos13stageva7",
  • "namespace": "ns-team-aem",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "environmentId": "string",
  • "region": "va7",
  • "integrations": {
    },
  • "status": "PENDING",
  • "type": "primary",
  • "_links": {
    }
}

Get Region Deployments

List the region deployments for an environment

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Create Region Deployment

Add region deployments in an environment

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of an environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

RegionDeployment

Array
region
required
string

Region to be added in the environment

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Patch Region Deployment

Remove region deployments from an environment

path Parameters
programId
required
string

Identifier of the application

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

RegionDeployment

Array
id
required
string

Identifier of the region deployment

status
required
string

Status of the region deployment to be set

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Variables

List User Environment Variables

List the user defined variables for an environment (Cloud Service only).

path Parameters
programId
required
string
Example: 2351

Identifier of the program

environmentId
required
string
Example: 128

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 1,
  • "_embedded": {
    },
  • "_links": {
    }
}

Patch User Environment Variables

Modify multiple environment variables (Cloud Service only). To delete a variable, include it with an empty value.

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

The list of variables to add, modify, or remove. It is not necessary to send variables here which are not changing. The length of secretString values must be less than 500 characters.

Array
name
string [ 2 .. 100 ] characters [a-zA-Z_][a-zA-Z_0-9]*

Name of the variable. Can only consist of a-z, A-Z, _ and 0-9 and cannot begin with a number.

value
string [ 0 .. 2048 ] characters

Value of the variable. Read-Write for non-secrets, write-only for secrets. The length of secretString values must be less than 500 characters. An empty value causes a variable to be deleted.

type
string
Enum: "string" "secretString"

Type of the variable. Default string if missing. secretString variables are encrypted at rest. The type of a variable be changed after creation; the variable must be deleted and recreated.

service
string

Service of the variable. When not provided, the variable applies to all services. Currently the values 'author', 'publish', and 'preview' are supported. Note - this value is case-sensitive.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

List User Pipeline Variables

List the user defined variables for an pipeline.

path Parameters
programId
required
string
Example: 2351

Identifier of the program

pipelineId
required
string
Example: 128

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 1,
  • "_embedded": {
    },
  • "_links": {
    }
}

Patch User Pipeline Variables

Modify multiple pipeline variables. To delete a variable, include it with an empty value.

path Parameters
programId
required
string

Identifier of the program

pipelineId
required
string

Identifier of the pipeline

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

The list of variables to add, modify, or remove. It is not necessary to send variables here which are not changing. The length of secretString values must be less than 500 characters.

Array
name
string [ 2 .. 100 ] characters [a-zA-Z_][a-zA-Z_0-9]*

Name of the variable. Can only consist of a-z, A-Z, _ and 0-9 and cannot begin with a number.

value
string [ 0 .. 2048 ] characters

Value of the variable. Read-Write for non-secrets, write-only for secrets. The length of secretString values must be less than 500 characters. An empty value causes a variable to be deleted.

type
string
Enum: "string" "secretString"

Type of the variable. Default string if missing. secretString variables are encrypted at rest. The type of a variable be changed after creation; the variable must be deleted and recreated.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Rapid Development Environments

Reset Rapid Development Environment

Reset Rapid Development Environment. Also updates the RDE to the latest AEM release.

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Environment Restore From Backup

Get Restore Points

List the backups available for this environment (Cloud Service only)

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Get Restore Execution

Returns a restore execution by its id (Cloud Service only)

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

restoreId
required
string

Identifier of the restore execution

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "environmentId": "14",
  • "status": "not_started",
  • "errorDetails": {
    },
  • "environmentDetailsAtSnapshotDate": {
    },
  • "environmentDetailsAtRestoreDate": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get Restore Execution Logs

Gets the logs of a Restore Execution (Cloud Service only)

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

restoreId
required
string

Identifier of the restore execution

header Parameters
Accept
string
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Lists Restore Executions

List the Restore Executions of an environment (Cloud Service only)

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

query Parameters
start
string
Default: "0"

Pagination start parameter

limit
integer <int32>
Default: 5

Pagination limit parameter

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "limits": {
    },
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Start a Restore Execution

Start a Restore from Backup execution (Cloud Service only)

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Restore Parameters Representation

pointInTimeInMillis
required
string\d{1,19}$

Desired point in time

Responses

Request samples

Content type
application/json
{
  • "pointInTimeInMillis": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "environmentId": "14",
  • "status": "not_started",
  • "errorDetails": {
    },
  • "environmentDetailsAtSnapshotDate": {
    },
  • "environmentDetailsAtRestoreDate": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

IP Allowlist

Get IP Allowlist

Returns an IP Allowlist based on program and id

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": 14,
  • "name": "NewYork Office",
  • "programId": 22,
  • "ipCidrSet": "[\"11.22.33.44/28\", \"99.88.77.66/32\"]",
  • "bindings": [
    ],
  • "_links": {
    }
}

Update IP Allowlist

Updates an IP Allowlist for the program with specified values

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

IP Allowlist

name
required
string

Name of the IP Allowed List

ipCidrSet
required
Array of strings [ 1 .. 50 ] items unique

IP CIDR Set

Responses

Request samples

Content type
application/json
{
  • "name": "NewYork Office",
  • "ipCidrSet": "[\"11.22.33.44/28\", \"99.88.77.66/32\"]"
}

Response samples

Content type
application/json
{
  • "id": 14,
  • "name": "NewYork Office",
  • "programId": 22,
  • "ipCidrSet": "[\"11.22.33.44/28\", \"99.88.77.66/32\"]",
  • "bindings": [
    ],
  • "_links": {
    }
}

Delete IP Allowlist

Deletes the IP Allowlist for the program

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": 14,
  • "name": "NewYork Office",
  • "programId": 22,
  • "ipCidrSet": "[\"11.22.33.44/28\", \"99.88.77.66/32\"]",
  • "bindings": [
    ],
  • "_links": {
    }
}

Lists IP Allowlists

Returns all IP Allowlists that are defined for this program

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Creates an IP Allowlist

Creates an IP Allowlist for the program with specified values

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

IP Allowlist

name
required
string

Name of the IP Allowed List

ipCidrSet
required
Array of strings [ 1 .. 50 ] items unique

IP CIDR Set

Responses

Request samples

Content type
application/json
{
  • "name": "NewYork Office",
  • "ipCidrSet": "[\"11.22.33.44/28\", \"99.88.77.66/32\"]"
}

Response samples

Content type
application/json
{
  • "id": 14,
  • "name": "NewYork Office",
  • "programId": 22,
  • "ipCidrSet": "[\"11.22.33.44/28\", \"99.88.77.66/32\"]",
  • "bindings": [
    ],
  • "_links": {
    }
}

IP Allowlist Binding

Get IP Allowlist binding

Returns an IP Allowlist binding based on program and IP allowlist id

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

ipAllowlistBindingId
required
string

Identifier of the IP Allowlist Binding

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": 14,
  • "tier": "publish",
  • "status": "NOT_STARTED",
  • "programId": 22,
  • "ipAllowListId": 17,
  • "environmentId": 5,
  • "_links": {
    }
}

Delete IP Allowlist binding

Deletes the IP Allowlist binding for the program and IP Allowlist id

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

ipAllowlistBindingId
required
string

Identifier of the IP Allowlist binding

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": 14,
  • "tier": "publish",
  • "status": "NOT_STARTED",
  • "programId": 22,
  • "ipAllowListId": 17,
  • "environmentId": 5,
  • "_links": {
    }
}

Lists IP Allowlist bindings

Returns all IP Allowlists bindings for an IpAllowList of a program

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "ipAllowlistId": "string",
  • "_embedded": {
    },
  • "_links": {
    }
}

Creates an IP Allowlist binding

Creates an IP Allowlist binding to an environment for a specific tier

path Parameters
programId
required
string

Identifier of the program

ipAllowlistId
required
string

Identifier of the IP Allowlist

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

IP Allowlist binding

id
integer <int64>

Identifier of the IP Allowed List Binding to an Environment

tier
string
Enum: "PUBLISH" "PREVIEW"

Tier of the environment.

status
string

Status of the binding.

programId
integer <int64>

Identifier of the program.

ipAllowListId
integer <int64>

Identifier of the IP allow list.

environmentId
required
integer <int64>

Identifier of the environment.

Responses

Request samples

Content type
application/json
{
  • "id": 14,
  • "tier": "publish",
  • "status": "NOT_STARTED",
  • "programId": 22,
  • "ipAllowListId": 17,
  • "environmentId": 5
}

Response samples

Content type
application/json
{
  • "id": 14,
  • "tier": "publish",
  • "status": "NOT_STARTED",
  • "programId": 22,
  • "ipAllowListId": 17,
  • "environmentId": 5,
  • "_links": {
    }
}

Domain

Get list of domains

Gets the list of domains for this program

path Parameters
programId
required
string

Identifier of program id

query Parameters
name
string

Domain name

anyVerified
boolean

Filter any verified

isTxt
boolean

Is TXT verified

isAcme
boolean

Is ACME verified

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Create domain

Creates a domain in this program

path Parameters
programId
required
string

Identifier of program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for creating a domain

domainName
string

Name of the domain name

Responses

Request samples

Content type
application/json
{
  • "domainName": "customer.domain.com"
}

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Get domain

Gets a domain by its ID

path Parameters
programId
required
string

Identifier of program id

domain-id
required
string

Identifier of domain id

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Update domain

Updates a domain with specified values

path Parameters
programId
required
string

Identifier of program id

domain-id
required
string

Identifier of domain id

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Domain Update Body

label
required
string

Domain label

Responses

Request samples

Content type
application/json
{
  • "label": "any string"
}

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Delete domain

Delete a domain from this program

path Parameters
programId
required
string

Identifier of program id

domain-id
required
string

Identifier of domain id

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Check validation

Validate the domain based on the type of validation token

path Parameters
programId
required
string

Identifier of program id

domain-id
required
string

Identifier of domain id

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for validation operation

validationType
string
Enum: "acme" "adobe"

Type of the validation

Responses

Request samples

Content type
application/json
{
  • "validationType": "acme"
}

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Creates validation token

Creates a validation token in order to establish the ownership of the domain

path Parameters
programId
required
string

Identifier of program id

domain-id
required
string

Identifier of domain id

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for validation operation

validationType
string
Enum: "acme" "adobe"

Type of the validation

Responses

Request samples

Content type
application/json
{
  • "validationType": "acme"
}

Response samples

Content type
application/json
{
  • "deleted": false,
  • "id": 0,
  • "domainName": "customer.domain.com",
  • "label": "string",
  • "programId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "acmeValidationStatus": "NOT_VERIFIED",
  • "adobeValidationStatus": "NOT_VERIFIED",
  • "acmeValidationToken": "string",
  • "adobeValidationToken": "string"
}

Domain Mappings - CDN Configurations

Get domain mapping

Gets a domain mapping by its ID

path Parameters
programId
required
integer <int64>

Identifier of program

domainMappingId
required
integer <int64>

Identifier of domain mapping

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "domainMappingId": 0,
  • "programId": 0,
  • "originId": 0,
  • "domainMappingStatus": "string",
  • "domainName": "string",
  • "originType": "string",
  • "tier": "PUBLISH",
  • "domainId": 0,
  • "certificateId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0
}

Update domain mapping

Updates a domain mapping with the specified values

path Parameters
programId
required
integer <int64>

Identifier of program

domainMappingId
required
integer <int64>

Identifier of domain mapping

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for updating a domain mapping

certificateId
required
integer <int64>

Certificate ID

tier
required
string
Enum: "PUBLISH" "PREVIEW" "AUTHOR" "STATIC" "DELIVERY"

Type of tier: PREVIEW or PUBLISH

Responses

Request samples

Content type
application/json
{
  • "certificateId": 0,
  • "tier": "PUBLISH"
}

Response samples

Content type
application/json
{
  • "domainMappingId": 0,
  • "programId": 0,
  • "originId": 0,
  • "domainMappingStatus": "string",
  • "domainName": "string",
  • "originType": "string",
  • "tier": "PUBLISH",
  • "domainId": 0,
  • "certificateId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0
}

Delete domain mapping

Deletes a domain mapping

path Parameters
programId
required
integer <int64>

Identifier of program

domainMappingId
required
integer <int64>

Identifier of domain mapping

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "domainMappingId": 0,
  • "programId": 0,
  • "originId": 0,
  • "domainMappingStatus": "string",
  • "domainName": "string",
  • "originType": "string",
  • "tier": "PUBLISH",
  • "domainId": 0,
  • "certificateId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0
}

Check if customer made the required DNS changes

Check if customer made the required DNS changes in order to route traffic from the domain

path Parameters
programId
required
integer <int64>

Identifier of program

domainMappingId
required
integer <int64>

Identifier of domain mapping

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "domainMappingId": 0,
  • "programId": 0,
  • "originId": 0,
  • "domainMappingStatus": "string",
  • "domainName": "string",
  • "originType": "string",
  • "tier": "PUBLISH",
  • "domainId": 0,
  • "certificateId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0
}

List of domain mappings

Gets the list of domain mappings from this program.

path Parameters
programId
required
integer <int64>

Identifier of program

query Parameters
originId
integer <int64>

Filtering by origin ID

certificateId
integer <int64>

Filtering by certificateId

domainId
integer <int64>

Filtering by domainId

status
string

Filtering by status separated by comma

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "totalNumberOfItems": 0,
  • "domainMappings": [
    ]
}

Create domain mapping

Creates a domain mapping (CDN configuration) in this program

path Parameters
programId
required
integer <int64>

Identifier of program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for creating a domain mapping

originId
required
integer <int64>

Origin ID: EDS or Skyline Environment ID

domainId
required
integer <int64>

Domain ID

certificateId
required
integer <int64>

Certificate ID

tier
required
string
Enum: "PUBLISH" "PREVIEW"

Type of the tier: PREVIEW or PUBLISH

originType
required
string
Enum: "EDS_SITE" "SKYLINE_ENVIRONMENT"

Type of the origin: EDS_SITE or SKYLINE_ENVIRONMENT

Responses

Request samples

Content type
application/json
{
  • "originId": 0,
  • "domainId": 0,
  • "certificateId": 0,
  • "tier": "PUBLISH",
  • "originType": "EDS_SITE"
}

Response samples

Content type
application/json
{
  • "domainMappingId": 0,
  • "programId": 0,
  • "originId": 0,
  • "domainMappingStatus": "string",
  • "domainName": "string",
  • "originType": "string",
  • "tier": "PUBLISH",
  • "domainId": 0,
  • "certificateId": 0,
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0
}

List of domain mappings by environment

Gets the list of domain mappings for the specified environment ID.

path Parameters
programId
required
integer <int64>

Identifier of program

environmentId
required
integer <int64>

Identifier of environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "totalNumberOfItems": 0,
  • "domainMappings": [
    ]
}

List of domain mappings by EDS site

Get the list of domain mappings for the specified EDS site ID.

path Parameters
programId
required
integer <int64>

Identifier of program

siteId
required
integer <int64>

Identifier of EDS site

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "totalNumberOfItems": 0,
  • "domainMappings": [
    ]
}

SSL Certificates

Get certificate

Gets a certificate by its ID

path Parameters
programId
required
integer <int64>

Identifier of the program

certificateId
required
integer <int64>

Identifier of the certificate

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "sslCertificateType": "string",
  • "sslCertificateStatus": "string",
  • "programId": 14,
  • "serialNumber": "string",
  • "name": "Certificate Name Example",
  • "issuer": "string",
  • "expireAt": 0,
  • "commonName": "string",
  • "subjectAlternativeNames": [
    ],
  • "certificate": "string",
  • "chain": "string",
  • "createdAt": 0,
  • "updatedAt": 0,
  • "_links": {
    }
}

Update certificate

Updates a certificate in this program

path Parameters
programId
required
integer <int64>

Identifier of the program

certificateId
required
integer <int64>

Identifier of the certificate

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for updating the certificate

name
required
string

The name of the new SSL Certificate.

certificate
required
string

The PEM-encoded certificate.

required
object

The PEM-encoded private key.

chain
required
string

The PEM-encoded certificate chain.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "certificate": "string",
  • "privateKey": {
    },
  • "chain": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sslCertificateType": "string",
  • "sslCertificateStatus": "string",
  • "programId": 14,
  • "serialNumber": "string",
  • "name": "Certificate Name Example",
  • "issuer": "string",
  • "expireAt": 0,
  • "commonName": "string",
  • "subjectAlternativeNames": [
    ],
  • "certificate": "string",
  • "chain": "string",
  • "createdAt": 0,
  • "updatedAt": 0,
  • "_links": {
    }
}

Delete certificate

Deletes a certificate from this program

path Parameters
programId
required
integer <int64>

Identifier of the program

certificateId
required
integer <int64>

Identifier of the certificate

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "sslCertificateType": "string",
  • "sslCertificateStatus": "string",
  • "programId": 14,
  • "serialNumber": "string",
  • "name": "Certificate Name Example",
  • "issuer": "string",
  • "expireAt": 0,
  • "commonName": "string",
  • "subjectAlternativeNames": [
    ],
  • "certificate": "string",
  • "chain": "string",
  • "createdAt": 0,
  • "updatedAt": 0,
  • "_links": {
    }
}

Get all certificates

Gets the list of certificates from this program

path Parameters
programId
required
integer <int64>

Identifier of the program

query Parameters
start
string
Default: "0"

Pagination start parameter

limit
integer <int32>
Default: 20

Pagination limit parameter

status
string
Enum: "VALID" "PENDING" "EXPIRED"

Filter statuses separated by comma

name
string

Certificate name

sslCertificateType
string
Enum: "DV" "EV" "OV"

Certificate types separated by comma.

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Add SSL certificate

Adds a customer-managed certificate in this program

path Parameters
programId
required
integer <int64>

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for creating the certificate

name
required
string

The name of the new SSL Certificate.

certificate
required
string

The PEM-encoded certificate.

required
object

The PEM-encoded private key.

chain
required
string

The PEM-encoded certificate chain.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "certificate": "string",
  • "privateKey": {
    },
  • "chain": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sslCertificateType": "string",
  • "sslCertificateStatus": "string",
  • "programId": 14,
  • "serialNumber": "string",
  • "name": "Certificate Name Example",
  • "issuer": "string",
  • "expireAt": 0,
  • "commonName": "string",
  • "subjectAlternativeNames": [
    ],
  • "certificate": "string",
  • "chain": "string",
  • "createdAt": 0,
  • "updatedAt": 0,
  • "_links": {
    }
}

Create DV certificate

Initiates the creation of a DV certificate in this program

path Parameters
programId
required
integer <int64>

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Payload for creating the DV certificate

name
string

Name of the certificate

domainIds
required
Array of integers <int64> [ items <int64 > ]

List of domain IDs to associate with the certificate

Responses

Request samples

Content type
application/json
{
  • "name": "my-cert",
  • "domainIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "sslCertificateType": "DV",
  • "programId": 0,
  • "serialNumber": "string",
  • "name": "string",
  • "certificate": "string",
  • "issuer": "string",
  • "expireAt": 0,
  • "privateKeyPath": "string",
  • "commonName": "string",
  • "commonNameRegex": "string",
  • "subjectAlternativeNames": [
    ],
  • "subjectAlternativeNamesRegex": [
    ],
  • "chain": "string",
  • "createdAt": 0,
  • "updatedAt": 0,
  • "deletedAt": 0,
  • "externalId": 0,
  • "sslCertificateStatus": "PENDING"
}

EDS Sites

Get Site by Id

path Parameters
programId
required
string
siteId
required
integer <int64>
header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "siteId": 0,
  • "programId": "string",
  • "siteName": "string",
  • "repoUrl": "string",
  • "siteStatus": "string",
  • "validationToken": "string",
  • "createdAt": 0,
  • "modifiedAt": 0,
  • "deletedAt": 0,
  • "deleted": false,
  • "_links": {
    }
}

Update Site

path Parameters
programId
required
string
siteId
required
integer <int64>
header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "siteId": 0,
  • "programId": "string",
  • "siteName": "string",
  • "repoUrl": "string",
  • "siteStatus": "string",
  • "validationToken": "string",
  • "createdAt": 0,
  • "modifiedAt": 0,
  • "deletedAt": 0,
  • "deleted": false,
  • "_links": {
    }
}

Delete Site

path Parameters
programId
required
string
siteId
required
integer <int64>
header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "siteId": 0,
  • "programId": "string",
  • "siteName": "string",
  • "repoUrl": "string",
  • "siteStatus": "string",
  • "validationToken": "string",
  • "createdAt": 0,
  • "modifiedAt": 0,
  • "deletedAt": 0,
  • "deleted": false,
  • "_links": {
    }
}

Validate Site

path Parameters
programId
required
string

Identifier of the program

siteId
required
integer <int64>

Identifier of the site

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "siteId": 0,
  • "programId": "string",
  • "siteName": "string",
  • "repoUrl": "string",
  • "siteStatus": "string",
  • "validationToken": "string",
  • "createdAt": 0,
  • "modifiedAt": 0,
  • "deletedAt": 0,
  • "deleted": false,
  • "_links": {
    }
}

Get All Sites by programId

path Parameters
programId
required
string
header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Create Site

path Parameters
programId
required
string
header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "siteId": 0,
  • "programId": "string",
  • "siteName": "string",
  • "repoUrl": "string",
  • "siteStatus": "string",
  • "validationToken": "string",
  • "createdAt": 0,
  • "modifiedAt": 0,
  • "deletedAt": 0,
  • "deleted": false,
  • "_links": {
    }
}

Tenants

List Tenants

Lists all tenants

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Get Tenant

Returns a tenant by its id

path Parameters
tenantId
required
string

Identifier of the tenant

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "14",
  • "imsOrgId": "1AAA222B3C4444D55E666666@AdobeOrg",
  • "imsTenantId": "acmeCorp",
  • "description": "Description for acmeCorp",
  • "status": "creating",
  • "organisation": {
    },
  • "_links": {
    }
}

Regions

Lists Regions

Returns all Regions that can be used to create environments for this program.

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Network infrastructure

List Network Infrastructures

Lists all network infrastructures in an program

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Create network configuration

Create a new network configuration

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Configuration

kind
required
string
Enum: "vpn" "dedicatedEgressIp" "flexiblePortEgress"

Kind of the infrastructure

region
required
string

Region to create the infrastructure. Use your primary region, whose identifier can be retrieved from the List Regions endpoint.

isPrimaryRegion
boolean
Default: false

Boolean property to mark whether network infrastructure being created is for primary region or not.

addressSpace
Array of strings

A list of CIDRs. It can only be one /26 CIDR (64 IP addresses) or bigger IP range in the customer space. Cannot be changed later. Only applicable to VPN.

object (DnsConfiguration)

DNS Information. Only applicable to VPN infrastructures.

Array of objects (VpnConnection)

List of VPN connections

object (ErrorDetailsRepresentation)

Responses

Request samples

Content type
application/json
{
  • "kind": "vpn",
  • "region": "va6",
  • "isPrimaryRegion": false,
  • "addressSpace": [
    ],
  • "dns": {
    },
  • "connections": [
    ],
  • "statusDetails": { }
}

Response samples

Content type
application/json
{
  • "kind": "vpn",
  • "id": "string",
  • "programId": "14",
  • "status": "creating",
  • "region": "va6",
  • "isPrimaryRegion": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "addressSpace": [
    ],
  • "dns": {
    },
  • "connections": [
    ],
  • "statusDetails": {
    },
  • "_links": {
    }
}

Get network infrastructure

Gets an existing network infrastructure

path Parameters
programId
required
string

Identifier of the program

networkInfrastructureId
required
string

Identifier of the network infrastructure

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "kind": "vpn",
  • "id": "string",
  • "programId": "14",
  • "status": "creating",
  • "region": "va6",
  • "isPrimaryRegion": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "addressSpace": [
    ],
  • "dns": {
    },
  • "connections": [
    ],
  • "statusDetails": {
    },
  • "_links": {
    }
}

Update network infrastructure

Updates an existing network infrastructure

path Parameters
programId
required
string

Identifier of the program

networkInfrastructureId
required
string

Identifier of the network infrastructure

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Configuration

kind
required
string
Enum: "vpn" "dedicatedEgressIp" "flexiblePortEgress"

Kind of the infrastructure

region
required
string

Region to create the infrastructure. Use your primary region, whose identifier can be retrieved from the List Regions endpoint.

isPrimaryRegion
boolean
Default: false

Boolean property to mark whether network infrastructure being created is for primary region or not.

addressSpace
Array of strings

A list of CIDRs. It can only be one /26 CIDR (64 IP addresses) or bigger IP range in the customer space. Cannot be changed later. Only applicable to VPN.

object (DnsConfiguration)

DNS Information. Only applicable to VPN infrastructures.

Array of objects (VpnConnection)

List of VPN connections

object (ErrorDetailsRepresentation)

Responses

Request samples

Content type
application/json
{
  • "kind": "vpn",
  • "region": "va6",
  • "isPrimaryRegion": false,
  • "addressSpace": [
    ],
  • "dns": {
    },
  • "connections": [
    ],
  • "statusDetails": { }
}

Response samples

Content type
application/json
{
  • "kind": "vpn",
  • "id": "string",
  • "programId": "14",
  • "status": "creating",
  • "region": "va6",
  • "isPrimaryRegion": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "addressSpace": [
    ],
  • "dns": {
    },
  • "connections": [
    ],
  • "statusDetails": {
    },
  • "_links": {
    }
}

Delete network infrastructure

Deletes an existing network infrastructure

path Parameters
programId
required
string

Identifier of the program

networkInfrastructureId
required
string

Identifier of the network infrastructure

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "kind": "vpn",
  • "id": "string",
  • "programId": "14",
  • "status": "creating",
  • "region": "va6",
  • "isPrimaryRegion": false,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "addressSpace": [
    ],
  • "dns": {
    },
  • "connections": [
    ],
  • "statusDetails": {
    },
  • "_links": {
    }
}

Environment Advanced Networking Configuration

Get Environment Advanced Networking Configurations

Returns environment advanced networking configurations by its id

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_embedded": {
    },
  • "_links": {
    }
}

Enable Environment Advanced Networking Configuration

Enable an environment advanced networking configuration by its id

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Environment Advanced Networking Configuration

nonProxyHosts
Array of strings

A list of hosts that should be reached directly, bypassing the special VPN or egress routing. The patterns may start or end with a ''*'' for wildcards.

Array of objects (PortForwardRepresentation)

List of port forwarding rules

Responses

Request samples

Content type
application/json
{
  • "nonProxyHosts": [
    ],
  • "portForwards": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "name": "AcmeCorp Dev1 Environment",
  • "description": "This is our primary development environment",
  • "type": "dev",
  • "status": "creating",
  • "region": "va7",
  • "availableLogOptions": [
    ],
  • "_links": {
    }
}

Disable Environment Advanced Networking Configuration

Disable an environment advanced networking configuration by its id

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "programId": "14",
  • "name": "AcmeCorp Dev1 Environment",
  • "description": "This is our primary development environment",
  • "type": "dev",
  • "status": "creating",
  • "region": "va7",
  • "availableLogOptions": [
    ],
  • "_links": {
    }
}

ContentSets

Lists Content Sets for program

Returns all content sets defined for the program.

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Create content set

create a content set

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Content set

name
string

The name of this content set.

description
string

The description of this content set.

Array of objects (ContentSetPath)

Included asset paths

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "paths": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "name": "string",
  • "paths": [
    ],
  • "programId": "658",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Get content set

Gets a content set by Id

path Parameters
programId
required
string

Identifier of the program

contentSetId
required
string

Identifier of the content set

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "123",
  • "name": "string",
  • "paths": [
    ],
  • "programId": "658",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Update content set

Updates the content set

path Parameters
programId
required
string

Identifier of the program

contentSetId
required
string

Identifier of the content set

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Content set

id
string

Identifier of the Content Set

name
string

The name of the content set

Array of objects (ContentSetPath) unique

Included asset paths

programId
string

Identifier of the program. Unique within the space.

Responses

Request samples

Content type
application/json
{
  • "id": "123",
  • "name": "string",
  • "paths": [
    ],
  • "programId": "658"
}

Response samples

Content type
application/json
{
  • "id": "123",
  • "name": "string",
  • "paths": [
    ],
  • "programId": "658",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

Delete content set

Deletes the content set by Id

path Parameters
programId
required
string

Identifier of the program

contentSetId
required
string

Identifier of the content set

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "id": "123",
  • "name": "string",
  • "paths": [
    ],
  • "programId": "658",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "_links": {
    }
}

List content flows for the program

List all content flows for a program

path Parameters
programId
required
string

Identifier of the program

query Parameters
start
string
Default: "0"

Pagination start parameter

limit
integer <int32>
Default: 20

Pagination limit parameter

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "_totalNumberOfItems": 0,
  • "_page": {
    },
  • "_embedded": {
    },
  • "_links": {
    }
}

Execute content flow using content set

Executes a content flow

path Parameters
programId
required
string

Identifier of the program

environmentId
required
string

Identifier of the source environment

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Content Flow details

contentSetId
string
destEnvironmentId
string
tier
string

tier

includeACL
boolean
Default: false

includeACL

destProgramId
string

destProgramId

mergeExcludePaths
boolean
Default: false

mergeExcludePaths

copyVersions
boolean
Default: false

copyVersions

Responses

Request samples

Content type
application/json
{
  • "contentSetId": "string",
  • "destEnvironmentId": "string",
  • "tier": "author",
  • "includeACL": false,
  • "destProgramId": "string",
  • "mergeExcludePaths": false,
  • "copyVersions": false
}

Response samples

Content type
application/json
{
  • "contentSetId": "string",
  • "contentSetName": "string",
  • "srcEnvironmentId": "string",
  • "srcEnvironmentName": "string",
  • "destEnvironmentId": "string",
  • "destEnvironmentName": "string",
  • "tier": "string",
  • "status": "string",
  • "destProgramId": "string",
  • "resultDetails": {
    },
  • "_links": {
    }
}

Backflow Compatibility between source and target environments

Returns the compatibility between source and target environments

path Parameters
programId
required
string

Identifier of the program

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Content-Type
required
string

Must always be application/json

Request Body schema: application/json

Program

sourceEnvironmentId
required
string
destinationEnvironmentId
required
string
tier
string
Enum: "PUBLISH" "AUTHOR"

Responses

Request samples

Content type
application/json
{
  • "sourceEnvironmentId": "string",
  • "destinationEnvironmentId": "string",
  • "tier": "PUBLISH"
}

Response samples

Content type
application/json
{
  • "sourceEnvironmentId": "1234",
  • "sourceTopologyId": "1a2b3cd4",
  • "destinationEnvironmentId": "5678",
  • "destinationTopologyId": "1a2b3cd4",
  • "tier": "author",
  • "overallResult": "PASS",
  • "overallMessage": "Destination Topology cannot be prod.",
  • "failedValidation": "TIER_NOT_ALLOWED",
  • "responseStatusCode": 0
}

Get content flow

Gets content flow for a program

path Parameters
programId
required
string

Identifier of the program

contentFlowId
required
string

Identifier of the contentFlow

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "contentSetId": "string",
  • "contentSetName": "string",
  • "srcEnvironmentId": "string",
  • "srcEnvironmentName": "string",
  • "destEnvironmentId": "string",
  • "destEnvironmentName": "string",
  • "tier": "string",
  • "status": "string",
  • "destProgramId": "string",
  • "resultDetails": {
    },
  • "_links": {
    }
}

Cancel content flow (Cloud Service only).

Cancel content flow

path Parameters
programId
required
string

Identifier of the program

contentFlowId
required
string

Identifier of the content flow

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "contentSetId": "string",
  • "contentSetName": "string",
  • "srcEnvironmentId": "string",
  • "srcEnvironmentName": "string",
  • "destEnvironmentId": "string",
  • "destEnvironmentName": "string",
  • "tier": "string",
  • "status": "string",
  • "destProgramId": "string",
  • "resultDetails": {
    },
  • "_links": {
    }
}

Get Content Flow Logs

Get Content Flow Logs

path Parameters
programId
required
string

Identifier of the program

contentFlowId
required
string

Identifier of the content flow

query Parameters
jobType
required
string

Job type (import, export)

header Parameters
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "download": {
    },
  • "logs/tail": {
    }
}

Download content flow logs

Download content flow logs

path Parameters
programId
required
string

Identifier of the program

contentFlowId
required
string

Identifier of the content flow

query Parameters
jobType
required
string

Job type (import, export)

header Parameters
Accept
string
x-gw-ims-org-id
required
string

IMS organization ID that the request is being made under.

Authorization
required
string

Bearer [token] - An access token for the technical account created through integration with Adobe IO

x-api-key
required
string

IMS Client ID (API Key) which is subscribed to consume services on console.adobe.io

Responses

Response samples

Content type
application/json
{
  • "redirect": "string"
}