Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Reactor API (1.0)

Download OpenAPI specification:Download

Use the Reactor API to programmatically manage resources and develop tag extensions in Adobe Experience Platform. Related documentation:

API paths:

Reactor Gateway URL: https://reactor.adobe.io
Example of a complete path for making a call to /properties: https://reactor.adobe.io/properties

Required headers:

All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on how to obtain these values, see the authentication tutorial.
All GET requests to the Reactor API require an Accept header to determine what data is returned by the system. In most cases, this value will be application/vnd.api+json;revision=# (where # is the revision number of the resource you want to retrieve, e.g. 1).
All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header Content-Type. The specific Content-Type value for each call is provided in the parameters sections in the endpoints listed below.

API error handling:
- Refer to the Experience Platform API troubleshooting guide for FAQs, API status codes, and request header errors.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Companies

A company represents the organization of a tags user, typically a business. These companies match 1:1 with IMS Organization IDs. API users will only have visibility into the companies to which they have access. Nearly all API usage is performed using an Adobe I/O integration which is scoped to a single IMS Org, and therefore the /companies endpoint is not a major part of most workflows. Most use cases start with a property instead.

List companies

NOTE: For more information on using this operation, see the companies endpoint guide on Experience League.

Request

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
org_id	string Filter by `org_id`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `Bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/companies

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Retrieve a company

NOTE: For more information on using this operation, see the companies endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/companies/{COMPANY_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"org_id": "string",
"updated_at": "string",
"token": "string",
"cjm_enabled": true,
"edge_enabled": true,
"edge_events_allotment": 0,
"edge_fanout_ratio": 0,
"premium_cdn_enabled": true,
"sla_enabled": true
},
"relationships": {"properties": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"properties": "string"
},
"meta": {"rights": ["string"
],
"platform_rights": {"web": ["string"
],
"mobile": ["string"
]
}
}
}
}

List a company's properties

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company whose properties you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
app_id	string Filter by `app_id`.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
copying	boolean Filter by `copying`. This is a legacy attribute that is specific to properties that were migrated from the original Dynamic Tag Management (DTM) system to the current system. A `copying` property is a property that is populating its information from its original DTM implementation.
enabled	string Filter by `enabled`.
platform	string Filter by `platform`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/companies/{COMPANY_ID}/properties

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a new property

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company that you want to define the property under.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/companies/{COMPANY_ID}/properties

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"platform": "string",
"development": true,
"domains": ["string"
],
"privacy": "string",
"rule_component_sequencing_enabled": true,
"ssl_enabled": true,
"undefined_vars_return_empty": true
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

List a company's app configurations

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company whose app configurations you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
app_id	string Filter by `app_id`.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
key_type	string Filter by `key_type`.
messaging_service	string Filter by `messaging_service`.
name	string Filter by `name`.
platform	string Filter by `platform`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/companies/{COMPANY_ID}/app_configurations

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an app configuration

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company that you want to define the app configuration under.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/companies/{COMPANY_ID}/app_configurations

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"app_id": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string",
"push_credential": { }
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"app_id": "string",
"name": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string"
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"company": "string",
"self": "string"
}
}
}

Properties

A property is a container that holds most of the other resources available within the Reactor API. The only resources that are not owned by a property are audit events, companies, extension packages, and profiles. A property belongs to exactly one company, and a company can have many properties.

List a company's properties

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company whose properties you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
app_id	string Filter by `app_id`.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
copying	boolean Filter by `copying`. This is a legacy attribute that is specific to properties that were migrated from the original Dynamic Tag Management (DTM) system to the current system. A `copying` property is a property that is populating its information from its original DTM implementation.
enabled	string Filter by `enabled`.
platform	string Filter by `platform`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/companies/{COMPANY_ID}/properties

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a new property

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company that you want to define the property under.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/companies/{COMPANY_ID}/properties

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"platform": "string",
"development": true,
"domains": ["string"
],
"privacy": "string",
"rule_component_sequencing_enabled": true,
"ssl_enabled": true,
"undefined_vars_return_empty": true
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Retrieve a property

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Delete a property

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/properties/{PROPERTY_ID}

Update a property

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being updated.

Responses

200

Success

patch/properties/{PROPERTY_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"platform": "string",
"development": true,
"domains": ["string"
],
"privacy": "string",
"rule_component_sequencing_enabled": true,
"ssl_enabled": true,
"undefined_vars_return_empty": true
},
"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Retrieve the company that owns a property

NOTE: For more information on using this operation, see the properties endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose company you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/properties/{PROPERTY_ID}/company

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"org_id": "string",
"updated_at": "string",
"token": "string",
"cjm_enabled": true,
"edge_enabled": true,
"edge_events_allotment": 0,
"edge_fanout_ratio": 0,
"premium_cdn_enabled": true,
"sla_enabled": true
},
"relationships": {"properties": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"properties": "string"
},
"meta": {"rights": ["string"
],
"platform_rights": {"web": ["string"
],
"mobile": ["string"
]
}
}
}
}

List a property's callbacks

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose callbacks you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/callbacks

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a new callback

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a callback for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/callbacks

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"subscriptions": ["string"
],
"url": "string"
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"subscriptions": ["string"
],
"updated_at": "string",
"url": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

List a property's data elements

NOTE: For more information on using this operation, see the data elements endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose data elements you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
published_at	string Filter by `published_at` timestamp.
published	string Filter by `published` status.
enabled	string Filter by `enabled`.
name	string Filter by `name`.
origin_id	string Filter by `origin_id`.
revision_number	string Filter by `revision_number`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/data_elements

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a data element

NOTE: For more information on using this operation, see the data elements endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a data element for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/data_elements

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"delegate_descriptor_id": "string",
"clean_text": true,
"default_value": { },
"enabled": true,
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"relationships": {"extension": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"updated_at": "string",
"clean_text": true,
"default_value": { },
"delegate_descriptor_id": "string",
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

List a property's environments

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose environments you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
stage	string Filter by `stage`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/environments

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create an environment for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/environments

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"archive": true,
"archive_passphrase": "string",
"path": "string",
"stage": "string"
},
"relationships": {"host": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"archive": true,
"created_at": "string",
"library_path": "string",
"library_name": "string",
"library_entry_points": [{"library_name": "string",
"minified": true,
"references": ["string"
],
"license_path": "string"
}
],
"name": "string",
"path": "string",
"stage": "string",
"updated_at": "string",
"status": "string",
"token": "string"
},
"relationships": {"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"builds": {"links": {"related": "string"
}
},
"host": {"links": {"related": "string",
"self": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"archive_encrypted": true,
"script_sources": ["string"
]
}
}
}

List a property's extensions

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose extensions you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
display_name	string Filter by `display_name`.
enabled	string Filter by `enabled`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.
version	string Filter by `version`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/extensions

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an extension

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create an extension for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/extensions

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"delegate_descriptor_id": "string",
"enabled": true,
"settings": "string"
},
"relationships": {"extension_package": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"delegate_descriptor_id": "string",
"display_name": "string",
"review_status": "string",
"version": "string",
"settings": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension_package": "string",
"latest_extension_package": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

List a property's hosts

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose hosts you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
display_name	string Filter by `display_name`.
enabled	string Filter by `enabled`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.
version	string Filter by `version`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/hosts

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a host

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a host for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/hosts

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"type_of": "string",
"encrypted_private_key": "string",
"server": "string",
"skip_symlinks": true,
"path": "string",
"port": 0,
"username": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"server": "string",
"name": "string",
"path": "string",
"port": 0,
"status": "string",
"skip_symlinks": true,
"type_of": "string",
"updated_at": "string",
"username": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

List a property's libraries

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose libraries you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
stale	string Filter by `stale` status. A library becomes stale when another library on the upstream has been changed and the current library needs to be rebuilt to reflect those changes. A library may also enter a stale state if one of the extensions it uses receives an update.
state	string Filter by `state`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/libraries

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a library for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/libraries

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"published_at": "string",
"state": "string",
"updated_at": "string",
"build_required": true,
"stale": "upstream_changed"
},
"relationships": {"builds": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"data_elements": {"links": {"related": "string",
"self": "string"
}
},
"extensions": {"links": {"related": "string",
"self": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string",
"self": "string"
}
},
"upstream_library": {"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"last_build": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"build_status": "string",
"build_required_detail": "string"
}
}
}

List a property's rules

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose rules you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
dirty	string Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
enabled	string Filter by `enabled`.
name	string Filter by `name`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/rules

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a rule

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a rule for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/rules

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"enabled": true
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"review_status": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"rule_components": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

List a property's secrets

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose secrets you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
environment_id	string Filter by `environment_id`.
name	string Filter by `name`.
status	string Filter by `status`.
type_of	string Filter by `type`.
updated_at	string Filter by `updated_at` timestamp.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/properties/{PROPERTY_ID}/secrets

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a secret

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a secret for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/secrets

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"type_of": "string",
"credentials": { }
},
"relationships": {"environment": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"name": "string",
"type_of": "string",
"activated_at": "string",
"expires_at": "string",
"refreshes_at": "string",
"status": "string",
"credentials": { }
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
},
"meta": {"stage": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"property": "string"
}
}
}

List a property's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a property

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Data elements

A data element functions as a variable which points to an important piece of data within your application. Data elements are used within rules and extension configurations. When the rule is triggered at runtime in a browser or an application, the value of the data element is resolved and used within the rule.

List a property's data elements

NOTE: For more information on using this operation, see the data elements endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose data elements you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
published_at	string Filter by `published_at` timestamp.
published	string Filter by `published` status.
enabled	string Filter by `enabled`.
name	string Filter by `name`.
origin_id	string Filter by `origin_id`.
revision_number	string Filter by `revision_number`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/data_elements

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a data element

NOTE: For more information on using this operation, see the data elements endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a data element for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/data_elements

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"delegate_descriptor_id": "string",
"clean_text": true,
"default_value": { },
"enabled": true,
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"relationships": {"extension": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"updated_at": "string",
"clean_text": true,
"default_value": { },
"delegate_descriptor_id": "string",
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

Retrieve a data element

NOTE: For more information on using this operation, see the data elements endpoint guide on Experience League.

Request

path Parameters

DATA_ELEMENT_ID

required

string

The ID of the data element you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/data_elements/{DATA_ELEMENT_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"updated_at": "string",
"clean_text": true,
"default_value": { },
"delegate_descriptor_id": "string",
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

Update a data element

When updating a data element, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

You can also create a new revision of the data element which is assigned its own ID. The original data element may be discovered via the origin link. Revising a data element is achieved by supplying a meta attribute containing an action property with the value revise. Excluding this property will update the current revision of the data element without creating a new one.

NOTE: For more information on using this operation, see the data elements endpoint guide on Experience League.

Request

path Parameters

DATA_ELEMENT_ID

required

string

The ID of the data element you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being updated.

Responses

200

Success

patch/data_elements/{DATA_ELEMENT_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"delegate_descriptor_id": "string",
"clean_text": true,
"default_value": { },
"enabled": true,
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"meta": {"action": "string"
},
"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"updated_at": "string",
"clean_text": true,
"default_value": { },
"delegate_descriptor_id": "string",
"force_lower_case": true,
"settings": "string",
"storage_duration": "pageview"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

List a data element's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

DATA_ELEMENT_ID

required

string

The ID of the data element whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/data_elements/{DATA_ELEMENT_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a data element

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

DATA_ELEMENT_ID

required

string

The ID of the data element that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/data_elements/{DATA_ELEMENT_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Rules

Rules control the behavior of the resources contained in a deployed library. A rule is a group of one or more rule components, and exists to tie the rule components together in a logical way.

List a property's rules

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose rules you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
dirty	string Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
enabled	string Filter by `enabled`.
name	string Filter by `name`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/rules

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a rule

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a rule for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/rules

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"enabled": true
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"review_status": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"rule_components": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

Retrieve a rule

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"review_status": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"rule_components": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

Delete a rule

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/rules/{RULE_ID}

Update a rule

When updating a rule, you have the option of creating a new revision of the rule which is assigned its own ID. The original rule may be discovered via the origin link. Revising a rule is achieved by supplying a meta attribute containing an action property with the value revise. Excluding this property will update the current revision of the rule without creating a new one.

When updating or revising a rule, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being updated.

Responses

200

Success

patch/rules/{RULE_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"enabled": true
},
"meta": {"action": "string"
},
"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"review_status": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"rule_components": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

List a rule's components

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose rule components you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
dirty	string Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
enabled	string Filter by `enabled`.
name	string Filter by `name`.
negate	string Filter by `negate` (whether the rule component represents a negation).
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/rule_components

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a new rule component

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule that you want to create a rule component for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/rules/{RULE_ID}/rule_components

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"delegate_descriptor_id": "string",
"delay_next": true,
"extension_id": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"settings": "string",
"timeout": 0
},
"relationships": {"extension": {"data": {"id": "string",
"type": "string"
}
},
"rules": {"data": [{"id": "string",
"type": "string"
}
]
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"delegate_descriptor_id": "string",
"deleted_at": "string",
"dirty": true,
"name": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"timeout": 0,
"delay_next": true,
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"settings": "string"
},
"relationships": {"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"extension": "string",
"origin": "string",
"rules": "string",
"self": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

List all libraries that use a specific rule

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose related libraries you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/libraries

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Retrieve the property that owns a specific rule

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose property you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/property

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Retrieve a rule's related origin

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose origin you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/origin

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"review_status": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"rule_components": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

List a rule's revisions

NOTE: For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose revisions you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/revisions

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List the notes for a rule's components

NOTE: Notes attached directly to the rule itself are not included in results for this endpoint. > >For more information on using this operation, see the rules endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose rule component notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/rule_component_notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List a rule's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a rule

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/rules/{RULE_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Rule components

Rule components are the individual items that make up a rule. Rule components have three basic types: events (what triggers a rule), conditions (what the rule checks to determine an action), and actions (what the rule executes depending on whether the condition is met). A rule component can only belong to exactly one rule.

List a rule's components

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose rule components you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
dirty	string Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
enabled	string Filter by `enabled`.
name	string Filter by `name`.
negate	string Filter by `negate` (whether the rule component represents a negation).
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/rule_components

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a new rule component

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule that you want to create a rule component for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/rules/{RULE_ID}/rule_components

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"delegate_descriptor_id": "string",
"delay_next": true,
"extension_id": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"settings": "string",
"timeout": 0
},
"relationships": {"extension": {"data": {"id": "string",
"type": "string"
}
},
"rules": {"data": [{"id": "string",
"type": "string"
}
]
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"delegate_descriptor_id": "string",
"deleted_at": "string",
"dirty": true,
"name": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"timeout": 0,
"delay_next": true,
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"settings": "string"
},
"relationships": {"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"extension": "string",
"origin": "string",
"rules": "string",
"self": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

Retrieve a rule component

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rule_components/{RULE_COMPONENT_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"delegate_descriptor_id": "string",
"deleted_at": "string",
"dirty": true,
"name": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"timeout": 0,
"delay_next": true,
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"settings": "string"
},
"relationships": {"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"extension": "string",
"origin": "string",
"rules": "string",
"self": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

Delete a rule component

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/rule_components/{RULE_COMPONENT_ID}

Update a rule component

When updating a rule component, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being updated.

Responses

200

Success

patch/rule_components/{RULE_COMPONENT_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"delegate_descriptor_id": "string",
"delay_next": true,
"extension_id": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"settings": "string",
"timeout": 0
},
"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"delegate_descriptor_id": "string",
"deleted_at": "string",
"dirty": true,
"name": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"timeout": 0,
"delay_next": true,
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"settings": "string"
},
"relationships": {"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"extension": "string",
"origin": "string",
"rules": "string",
"self": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

Look up the extension that provides a specific rule component.

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component whose extension you want to look up.

query Parameters

created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rule_components/{RULE_COMPONENT_ID}/extension

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"delegate_descriptor_id": "string",
"display_name": "string",
"review_status": "string",
"version": "string",
"settings": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension_package": "string",
"latest_extension_package": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

Retrieve a rule component's origin

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component whose origin you want to look up.

query Parameters

created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rule_components/{RULE_COMPONENT_ID}/origin

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"delegate_descriptor_id": "string",
"deleted_at": "string",
"dirty": true,
"name": "string",
"negate": true,
"order": 0,
"rule_order": 0,
"timeout": 0,
"delay_next": true,
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"settings": "string"
},
"relationships": {"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"rules": {"links": {"related": "string"
}
}
},
"links": {"extension": "string",
"origin": "string",
"rules": "string",
"self": "string"
},
"meta": {"latest_revision_number": "string"
}
}
}

List the rules that utilize a rule component

NOTE: For more information on using this operation, see the rule components endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component whose related rules you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rule_components/{RULE_COMPONENT_ID}/rules

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List a rule component's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rule_components/{RULE_COMPONENT_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a rule component

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/rule_components/{RULE_COMPONENT_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Extension packages

An extension package represents a grouping of individual capabilities that can be made available to a tags user. Most commonly, these capabilities come in the form of rule components (events, conditions, and actions) and data elements, but can also include main modules and shared modules. The capabilities provided by an extension package are installed as an extension when it is included in a library.

List extension packages

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
display_name	string Filter by `display_name`.
status	string Filter by `status`.
platform	string Filter by `platform`.
version	string Filter by `version`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extension_packages

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an extension package

NOTE: Instead of a JSON payload, this endpoint expects a file upload via multipart form data. > >For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `multipart/form-data` for all requests that require archive file uploads.

Request Body schema: multipart/form-data
required

package

required

string <binary>

The extension package archive file.

Responses

202

Success

post/extension_packages

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"actions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"author": {"url": "string",
"name": "string",
"email": "string"
},
"availability": "string",
"cdn_path": "string",
"conditions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"configuration": {"id": "string",
"schema": { },
"viewPath": "string",
"transforms": [{ }
]
},
"created_at": "string",
"data_elements": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"description": "string",
"discontinued": true,
"display_name": "string",
"events": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"exchange_url": "string",
"hosted_lib_files": ["string"
],
"icon_path": "string",
"main": "string",
"name": "string",
"owner_org_id": "string",
"resources": ["string"
],
"shared_modules": [{"name": "string",
"libPath": "string"
}
],
"status": "string",
"platform": "string",
"updated_at": "string",
"version": "string",
"view_base_path": "string"
},
"links": {"self": "string"
},
"meta": {"archive_url": "string",
"script_sources": ["string"
]
}
}
}

Retrieve an extension package

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_ID

required

string

The ID of the extension package you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extension_packages/{EXTENSION_PACKAGE_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"actions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"author": {"url": "string",
"name": "string",
"email": "string"
},
"availability": "string",
"cdn_path": "string",
"conditions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"configuration": {"id": "string",
"schema": { },
"viewPath": "string",
"transforms": [{ }
]
},
"created_at": "string",
"data_elements": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"description": "string",
"discontinued": true,
"display_name": "string",
"events": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"exchange_url": "string",
"hosted_lib_files": ["string"
],
"icon_path": "string",
"main": "string",
"name": "string",
"owner_org_id": "string",
"resources": ["string"
],
"shared_modules": [{"name": "string",
"libPath": "string"
}
],
"status": "string",
"platform": "string",
"updated_at": "string",
"version": "string",
"view_base_path": "string"
},
"links": {"self": "string"
},
"meta": {"archive_url": "string",
"script_sources": ["string"
]
}
}
}

Update an extension package

Only development extension packages can be updated using a new archive file. Once the extension package has been transitioned to either private or public, it can no longer be updated. If you want to add new functionality or fix bugs, you must first create a new extension package with the same name, but with a new version. When this new extension package is transitioned to private or public, it will become available in the marketplace and replace the previous version.

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_ID

required

string

The ID of the development extension package you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `multipart/form-data` for all requests that require archive file uploads.

Request Body schema: multipart/form-data
required

package

required

string <binary>

The extension package archive file.

Responses

200

Success

post/extension_packages/{EXTENSION_PACKAGE_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"actions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"author": {"url": "string",
"name": "string",
"email": "string"
},
"availability": "string",
"cdn_path": "string",
"conditions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"configuration": {"id": "string",
"schema": { },
"viewPath": "string",
"transforms": [{ }
]
},
"created_at": "string",
"data_elements": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"description": "string",
"discontinued": true,
"display_name": "string",
"events": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"exchange_url": "string",
"hosted_lib_files": ["string"
],
"icon_path": "string",
"main": "string",
"name": "string",
"owner_org_id": "string",
"resources": ["string"
],
"shared_modules": [{"name": "string",
"libPath": "string"
}
],
"status": "string",
"platform": "string",
"updated_at": "string",
"version": "string",
"view_base_path": "string"
},
"links": {"self": "string"
},
"meta": {"archive_url": "string",
"script_sources": ["string"
]
}
}
}

Privately release or discontinue an extension package

Once you have completed testing your extension package you can release it privately. This makes it available to any property within your company. After you have released it privately, you can begin the public release process by filling out the Public Release Request Form.

When privately releasing or discontinuing an extension package, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_ID

required

string

The ID of the development extension package you want to privately release or discontinue.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains info on the extension package being updated and the action being performed.

Responses

200

Success

patch/extension_packages/{EXTENSION_PACKAGE_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"meta": {"action": "string"
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"actions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"author": {"url": "string",
"name": "string",
"email": "string"
},
"availability": "string",
"cdn_path": "string",
"conditions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"configuration": {"id": "string",
"schema": { },
"viewPath": "string",
"transforms": [{ }
]
},
"created_at": "string",
"data_elements": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"description": "string",
"discontinued": true,
"display_name": "string",
"events": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"exchange_url": "string",
"hosted_lib_files": ["string"
],
"icon_path": "string",
"main": "string",
"name": "string",
"owner_org_id": "string",
"resources": ["string"
],
"shared_modules": [{"name": "string",
"libPath": "string"
}
],
"status": "string",
"platform": "string",
"updated_at": "string",
"version": "string",
"view_base_path": "string"
},
"links": {"self": "string"
},
"meta": {"archive_url": "string",
"script_sources": ["string"
]
}
}
}

Retrieve an extension package's versions

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_ID

required

string

The ID of the extension package whose versions you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extension_packages/{EXTENSION_PACKAGE_ID}/versions

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Extension package usage authorization

An extension package usage authorization is an authorization granted by the package owner to other companies for the private use of the extension package versions.

Retrieve extension package usage authorizations for an extension package

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_ID

required

string

The ID of the extension package you want to retrieve.

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extension_packages/{EXTENSION_PACKAGE_ID}/extension_package_usage_authorizations

Response samples

application/vnd.api+json

{"data": [{"id": "EA722482c30fe44b54aa6a7317890b3bdb",
"type": "extension_package_usage_authorizations",
"attributes": {"created_at": "2024-06-05T23:17:35.776Z",
"updated_at": "2024-06-05T23:17:35.776Z",
"name": "Acme",
"platform": "web",
"owner_org_id": "{ORG_ID}",
"owner_org_name": "Reactor QE",
"authorized_org_id": "{ORG_ID}",
"authorized_org_name": "Platform UI - INT",
"state": "pending_approval",
"created_by_email": "example@adobe.com",
"created_by_display_name": "George Ciltaru",
"updated_by_email": "Restricted",
"updated_by_display_name": "Restricted"
},
"relationships": {"extension_package": {"links": {"related": "https://reactor.adobe.io/extension_package_usage_authorizations/EA722482c30fe44b54aa6a7317890b3bdb/extension_package"
},
"data": {"id": "EPecefc8291ae346c3b3887d5b2da533b8",
"type": "extension_packages"
}
}
},
"links": {"self": "https://reactor.adobe.io/extension_package_usage_authorizations/EA722482c30fe44b54aa6a7317890b3bdb"
}
}
],
"meta": {"pagination": {"current_page": 1,
"next_page": null,
"prev_page": null,
"total_pages": 1,
"total_count": 1
}
}
}

Create an extension package usage authorization

NOTE: Instead of a JSON payload, this endpoint expects a file upload via multipart form data. > >For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_ID

required

string

The ID of the extension package you want to retrieve.

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `multipart/form-data` for all requests that require archive file uploads.

Request Body schema: application/vnd.api+json
required

object

Responses

201

Success

post/extension_packages/{EXTENSION_PACKAGE_ID}/extension_package_usage_authorizations

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"authorized_org_id": "{ORG_ID}"
},
"type": "extension_package_usage_authorizations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "EA35d0e731f73645e6972df9fcac101434",
"type": "extension_package_usage_authorizations",
"attributes": {"created_at": "2024-06-05T23:17:30.308Z",
"updated_at": "2024-06-05T23:17:30.308Z",
"name": "Acme",
"platform": "web",
"owner_org_id": "{ORG_ID}",
"owner_org_name": "Reactor QE",
"authorized_org_id": "{ORG_ID}",
"authorized_org_name": "Platform UI - INT",
"state": "pending_approval",
"created_by_email": "example@adobe.com",
"created_by_display_name": "George Ciltaru",
"updated_by_email": "Restricted",
"updated_by_display_name": "Restricted"
},
"relationships": {"extension_package": {"links": {"related": "https://reactor.adobe.io/extension_package_usage_authorizations/EA35d0e731f73645e6972df9fcac101434/extension_package"
},
"data": {"id": "EP43649cc8856d4f09a7c2a21a4b1e449d",
"type": "extension_packages"
}
}
},
"links": {"self": "https://reactor.adobe.io/extension_package_usage_authorizations/EA35d0e731f73645e6972df9fcac101434"
}
}
}

Retrieve a list of extension package usage authorizations

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extension_package_usage_authorizations

Response samples

application/vnd.api+json

{"data": [{"id": "EA35d0e731f73645e6972df9fcac101434",
"type": "extension_package_usage_authorizations",
"attributes": {"created_at": "2024-06-05T23:17:30.308Z",
"updated_at": "2024-06-05T23:17:30.308Z",
"name": "Acme",
"platform": "web",
"owner_org_id": "{ORG_ID}",
"owner_org_name": "Reactor QE",
"authorized_org_id": "{ORG_ID}",
"authorized_org_name": "Platform UI - INT",
"state": "pending_approval",
"created_by_email": "Restricted",
"created_by_display_name": "Restricted",
"updated_by_email": "example@adobe.com",
"updated_by_display_name": "George Ciltaru"
},
"relationships": {"extension_package": {"links": {"related": "https://reactor.adobe.io/extension_package_usage_authorizations/EA35d0e731f73645e6972df9fcac101434/extension_package"
},
"data": null
}
},
"links": {"self": "https://reactor.adobe.io/extension_package_usage_authorizations/EA35d0e731f73645e6972df9fcac101434"
}
}
],
"links": {"self": "https://reactor.adobe.io/extension_package_usage_authorizations?page%5Bnumber%5D=1&page%5Bsize%5D=25",
"next": "https://reactor.adobe.io/extension_package_usage_authorizations?page%5Bnumber%5D=2&page%5Bsize%5D=25",
"last": "https://reactor.adobe.io/extension_package_usage_authorizations?page%5Bnumber%5D=3&page%5Bsize%5D=25"
},
"meta": {"pagination": {"current_page": 1,
"next_page": 2,
"prev_page": null,
"total_pages": 3,
"total_count": 57
}
}
}

Delete an extension package usage authorization

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

required

string

The ID of the extension package usage authorization you want to delete.

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/extension_package_usage_authorizations/{ID}

Update an extension package usage authorization

NOTE: Instead of a JSON payload, this endpoint expects a file upload via multipart form data. > >For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

required

string

The ID of the extension package usage authorization you want to update.

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `multipart/form-data` for all requests that require archive file uploads.

Request Body schema: application/vnd.api+json
required

object

Responses

200

Success

patch/extension_package_usage_authorizations/{ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"state": "approved"
},
"type": "extension_package_usage_authorizations",
"id": "EA86f54b48dd7042a68686508e03be8ba9"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "EA86f54b48dd7042a68686508e03be8ba9",
"type": "extension_package_usage_authorizations",
"attributes": {"created_at": "2024-06-05T23:17:59.480Z",
"updated_at": "2024-06-05T23:18:00.115Z",
"name": "Acme",
"platform": "web",
"owner_org_id": "{ORG_ID}",
"owner_org_name": "Reactor QE",
"authorized_org_id": "{ORG_ID}",
"authorized_org_name": "Platform UI - INT",
"state": "approved",
"created_by_email": "Restricted",
"created_by_display_name": "Restricted",
"updated_by_email": "example@adobe.com",
"updated_by_display_name": "George Ciltaru"
},
"relationships": {"extension_package": {"links": {"related": "https://reactor.adobe.io/extension_package_usage_authorizations/EA86f54b48dd7042a68686508e03be8ba9/extension_package"
},
"data": {"id": "EPb91d54cad9f749dba4e5566459f84c9c",
"type": "extension_packages"
}
}
},
"links": {"self": "https://reactor.adobe.io/extension_package_usage_authorizations/EA86f54b48dd7042a68686508e03be8ba9"
}
}
}

Retrieve data for the extension package for an extension package usage authorization

NOTE: For more information on using this operation, see the extension packages endpoint guide on Experience League.

Request

path Parameters

EXTENSION_PACKAGE_USAGE_AUTHORIZATION_ID

required

string

The ID of the extension package usage authorization you want to retrieve.

header Parameters

Authorization required	string The access token which can be copied from your Experience Platform integration, prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extension_package_usage_authorizations/{EXTENSION_PACKAGE_USAGE_AUTHORIZATION_ID}/extension_package

Response samples

application/vnd.api+json

{"data": {"id": "EP45ae063fd75c4c22936d3d456c858cfa",
"type": "extension_packages",
"attributes": {"actions": [ ],
"author": {"url": "http://adobe.com",
"name": "Acme",
"email": "acme@adobe.com"
},
"availability": "private",
"cdn_path": "https://assets.adobedtm.com/staging/extensions/EP45ae063fd75c4c22936d3d456c858cfa",
"conditions": [ ],
"configuration": null,
"created_at": "2024-06-05T23:17:48.607Z",
"data_elements": [ ],
"description": "Provides nothing.",
"discontinued": false,
"display_name": "Acme Template Test",
"ecma_version": null,
"events": [ ],
"exchange_url": null,
"hosted_lib_files": null,
"icon_path": "resources/icons/core.svg",
"main": "null",
"name": "Acme",
"owner_org_id": "{ORG_ID}",
"resources": null,
"shared_modules": null,
"status": "succeeded",
"platform": "web",
"updated_at": "2024-06-05T23:17:53.806Z",
"version": "1.0.0",
"view_base_path": "dist/",
"created_by_email": "example@adobe.com",
"created_by_display_name": "George Ciltaru",
"updated_by_email": "example@adobe.com",
"updated_by_display_name": "George Ciltaru"
},
"relationships": {"extension_package": {"links": {"related": "https://reactor.adobe.io/extension_packages/EP45ae063fd75c4c22936d3d456c858cfa/extension_package_usage_authorizations"
}
}
},
"links": {"self": "https://reactor.adobe.io/extension_packages/EP45ae063fd75c4c22936d3d456c858cfa"
}
}
}

Extensions

An extension represents the installed instance of an extension package. An extension makes the features defined by an extension package available to a property. These features are leveraged when creating data elements and rule components.

List a property's extensions

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose extensions you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
display_name	string Filter by `display_name`.
enabled	string Filter by `enabled`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.
version	string Filter by `version`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/extensions

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an extension

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create an extension for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/extensions

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"delegate_descriptor_id": "string",
"enabled": true,
"settings": "string"
},
"relationships": {"extension_package": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"delegate_descriptor_id": "string",
"display_name": "string",
"review_status": "string",
"version": "string",
"settings": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension_package": "string",
"latest_extension_package": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

Retrieve an extension

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"delegate_descriptor_id": "string",
"display_name": "string",
"review_status": "string",
"version": "string",
"settings": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension_package": "string",
"latest_extension_package": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

Delete an extension

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/extensions/{EXTENSION_ID}

Revise an extension

This operation creates a new revision of an extension with the current (head) revision. A revision of an extension has its own ID, and the original extension may be discovered via the origin link.

When revising an extension, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension you want to revise.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being updated.

Responses

200

Success

patch/extensions/{EXTENSION_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"delegate_descriptor_id": "string",
"enabled": true,
"settings": "string"
},
"meta": {"action": "string"
},
"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"delegate_descriptor_id": "string",
"display_name": "string",
"review_status": "string",
"version": "string",
"settings": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension_package": "string",
"latest_extension_package": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

Retrieve the extension package for an extension

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose extension package you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/extension_package

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"actions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"author": {"url": "string",
"name": "string",
"email": "string"
},
"availability": "string",
"cdn_path": "string",
"conditions": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"configuration": {"id": "string",
"schema": { },
"viewPath": "string",
"transforms": [{ }
]
},
"created_at": "string",
"data_elements": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"description": "string",
"discontinued": true,
"display_name": "string",
"events": [{"id": "string",
"name": "string",
"schema": { },
"libPath": "string",
"viewPath": "string",
"transforms": [{ }
],
"displayName": "string",
"categoryName": "string"
}
],
"exchange_url": "string",
"hosted_lib_files": ["string"
],
"icon_path": "string",
"main": "string",
"name": "string",
"owner_org_id": "string",
"resources": ["string"
],
"shared_modules": [{"name": "string",
"libPath": "string"
}
],
"status": "string",
"platform": "string",
"updated_at": "string",
"version": "string",
"view_base_path": "string"
},
"links": {"self": "string"
},
"meta": {"archive_url": "string",
"script_sources": ["string"
]
}
}
}

List the libraries that use an extension

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose libraries you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/libraries

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Retrieve an extension's property

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose property you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/property

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Retrieve an extension's origin

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose origin you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/origin

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"deleted_at": "string",
"dirty": true,
"enabled": true,
"name": "string",
"published": true,
"published_at": "string",
"revision_number": 0,
"updated_at": "string",
"delegate_descriptor_id": "string",
"display_name": "string",
"review_status": "string",
"version": "string",
"settings": "string"
},
"relationships": {"libraries": {"links": {"related": "string"
}
},
"revisions": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"origin": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"updated_with_extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"extension_package": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"origin": "string",
"self": "string",
"extension_package": "string",
"latest_extension_package": "string"
},
"meta": {"latest_revision_number": 0
}
}
}

List an extension's revisions

NOTE: For more information on using this operation, see the extensions endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose revisions you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/revisions

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List an extension's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose notes you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for an extension

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/extensions/{EXTENSION_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Libraries

A library is a collection of resources (extensions, rules, and data elements) that represent the desired behavior of a property. Libraries are compiled into builds, and those builds are assigned to different environments as they move down the publishing flow from testing to production.

List a property's libraries

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose libraries you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
stale	string Filter by `stale` status. A library becomes stale when another library on the upstream has been changed and the current library needs to be rebuilt to reflect those changes. A library may also enter a stale state if one of the extensions it uses receives an update.
state	string Filter by `state`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/libraries

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a library for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/libraries

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"published_at": "string",
"state": "string",
"updated_at": "string",
"build_required": true,
"stale": "upstream_changed"
},
"relationships": {"builds": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"data_elements": {"links": {"related": "string",
"self": "string"
}
},
"extensions": {"links": {"related": "string",
"self": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string",
"self": "string"
}
},
"upstream_library": {"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"last_build": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"build_status": "string",
"build_required_detail": "string"
}
}
}

Retrieve a library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"published_at": "string",
"state": "string",
"updated_at": "string",
"build_required": true,
"stale": "upstream_changed"
},
"relationships": {"builds": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"data_elements": {"links": {"related": "string",
"self": "string"
}
},
"extensions": {"links": {"related": "string",
"self": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string",
"self": "string"
}
},
"upstream_library": {"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"last_build": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"build_status": "string",
"build_required_detail": "string"
}
}
}

Delete a library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/libraries/{LIBRARY_ID}

Update a library

This endpoint allows you to update the name of a library, or transition the library between different states in the publishing flow.

When updating a library, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

To transition the library between states, the payload must include a meta object, containing a single action property whose value represents the specific transition action. The available actions for a library depend on its current publishing state. See the API guide on transitioning a library for details on the available actions for each library state.

To update the name of a library, the payload must include an attributes object, containing a single name property with the updated value.

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains info on the library being updated and the action being performed.

Responses

200

Success

patch/libraries/{LIBRARY_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"name": "string"
},
"meta": {"action": "string"
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"published_at": "string",
"state": "string",
"updated_at": "string",
"build_required": true,
"stale": "upstream_changed"
},
"relationships": {"builds": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"data_elements": {"links": {"related": "string",
"self": "string"
}
},
"extensions": {"links": {"related": "string",
"self": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string",
"self": "string"
}
},
"upstream_library": {"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"last_build": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"build_status": "string",
"build_required_detail": "string"
}
}
}

Retrieve a library's property

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose related property you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/property

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

List a library's builds

NOTE: For more information on using this operation, see the builds endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose builds you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
status	string Filter by `status`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/builds

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a build

This POST request does not accept a payload, as the build parameters are determined by the parent library.

NOTE: For more information on using this operation, see the builds endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to create a build for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

201

Success

post/libraries/{LIBRARY_ID}/builds

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"status": "string",
"updated_at": "string",
"token": "string"
},
"relationships": {"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"environment": "string",
"library": "string",
"self": "string"
},
"meta": {"artifact_url": "string",
"direct_artifact_url": "string",
"archive": true,
"host_type_of": "string"
}
}
}

Retrieve a library's related environment

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose related environment you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/environment

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"archive": true,
"created_at": "string",
"library_path": "string",
"library_name": "string",
"library_entry_points": [{"library_name": "string",
"minified": true,
"references": ["string"
],
"license_path": "string"
}
],
"name": "string",
"path": "string",
"stage": "string",
"updated_at": "string",
"status": "string",
"token": "string"
},
"relationships": {"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"builds": {"links": {"related": "string"
}
},
"host": {"links": {"related": "string",
"self": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"archive_encrypted": true,
"script_sources": ["string"
]
}
}
}

Retrieve a library's upstream library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose upstream library you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/upstream_library

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"published_at": "string",
"state": "string",
"updated_at": "string",
"build_required": true,
"stale": "upstream_changed"
},
"relationships": {"builds": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"data_elements": {"links": {"related": "string",
"self": "string"
}
},
"extensions": {"links": {"related": "string",
"self": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string",
"self": "string"
}
},
"upstream_library": {"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"last_build": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"build_status": "string",
"build_required_detail": "string"
}
}
}

List a library's related data elements

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose related data elements you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/data_elements

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List a library's data element relationships

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose data element relationships you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/relationships/data_elements

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Add data elements to a specific library.

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to add data elements to.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities you wish to establish relationships with.

Responses

200

Success

post/libraries/{LIBRARY_ID}/relationships/data_elements

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Remove a library's data element relationships

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to remove a data element relationship from.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities that you want to remove from the parent entity's list of relationships.

Responses

200

Success

delete/libraries/{LIBRARY_ID}/relationships/data_elements

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Replace all data element relationships for a specific library

This call replaces all of the existing data element relationships for a library with those you provide in the payload array.

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to replace a data element relationship for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities you wish to establish relationships with.

Responses

200

Success

patch/libraries/{LIBRARY_ID}/relationships/data_elements

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Retrieve a library's environment relationship

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose environment relationship you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/relationships/environment

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Remove a library's environment relationship

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to remove an environment relationship from.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Responses

200

Success

delete/libraries/{LIBRARY_ID}/relationships/environment

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Set a library's environment relationship

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to set an environment relationship for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

object

Lists the basic details of the entity you wish to establish a relationship with.

Responses

200

Success

patch/libraries/{LIBRARY_ID}/relationships/environment

Request samples

Payload

application/vnd.api+json

{"data": {"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

List a library's related extensions

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose related extensions you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/extensions

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List a library's extension relationships

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose extension relationships you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/relationships/extensions

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Add extensions to a specific library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to add extensions to.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities you wish to establish relationships with.

Responses

200

Success

post/libraries/{LIBRARY_ID}/relationships/extensions

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Remove a library's extensions

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to remove extensions from.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Responses

200

Success

delete/libraries/{LIBRARY_ID}/relationships/extensions

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Replace all extensions for a specific library

This call replaces all of the existing extension relationships for a library with those you provide in the payload array.

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose extensions you want to replace.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities you wish to establish relationships with.

Responses

200

Success

patch/libraries/{LIBRARY_ID}/relationships/extensions

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

List a library's related rules

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose related rules you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/rules

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List a library's rule relationships

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose rule relationships you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/relationships/rules

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Add rules to a specific library

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to add rules to.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities you wish to establish relationships with.

Responses

200

Success

post/libraries/{LIBRARY_ID}/relationships/rules

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Remove a library's rules

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to remove rules from.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities that you want to remove from the parent entity's list of relationships.

Responses

200

Success

delete/libraries/{LIBRARY_ID}/relationships/rules

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Replace all rules for a specific library

This call replaces all of the existing rule relationships for a library with those you provide in the payload array.

NOTE: For more information on using this operation, see the libraries endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose rules you want to replace.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

Array of objects

Lists the basic details of the entities you wish to establish relationships with.

Responses

200

Success

patch/libraries/{LIBRARY_ID}/relationships/rules

Request samples

Payload

application/vnd.api+json

{"data": [{"id": "string",
"type": "string"
}
]
}

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

List a library's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a library

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/libraries/{LIBRARY_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Builds

A tag library is compiled into a build in order for it to be assigned to an environment for testing and deployment. The contents of a build varies depending on the resources included in the library, the configuration of the environment to which the build is assigned, and the platform of the property that the build belongs to.

List a library's builds

NOTE: For more information on using this operation, see the builds endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose builds you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
status	string Filter by `status`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/builds

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a build

This POST request does not accept a payload, as the build parameters are determined by the parent library.

NOTE: For more information on using this operation, see the builds endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to create a build for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

201

Success

post/libraries/{LIBRARY_ID}/builds

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"status": "string",
"updated_at": "string",
"token": "string"
},
"relationships": {"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"environment": "string",
"library": "string",
"self": "string"
},
"meta": {"artifact_url": "string",
"direct_artifact_url": "string",
"archive": true,
"host_type_of": "string"
}
}
}

Look up a build by ID.

NOTE: For more information on using this operation, see the builds endpoint guide on Experience League.

Request

path Parameters

BUILD_ID

required

string

The ID of the build you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/builds/{BUILD_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"status": "string",
"updated_at": "string",
"token": "string"
},
"relationships": {"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"environment": "string",
"library": "string",
"self": "string"
},
"meta": {"artifact_url": "string",
"direct_artifact_url": "string",
"archive": true,
"host_type_of": "string"
}
}
}

Republish a build

When republishing a build, its ID must be provided in both the request path and the request payload. These IDs must match in order for the call to be successful.

NOTE: For more information on using this operation, see the builds endpoint guide on Experience League.

Request

path Parameters

BUILD_ID

required

string

The ID of the build you want to republish.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the build being republished.

Responses

200

Success

patch/builds/{BUILD_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"id": "BLb408c04c20ba4a82b6df496969a99781",
"type": "builds",
"meta": {"action": "republish"
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"status": "string",
"updated_at": "string",
"token": "string"
},
"relationships": {"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"environment": "string",
"library": "string",
"self": "string"
},
"meta": {"artifact_url": "string",
"direct_artifact_url": "string",
"archive": true,
"host_type_of": "string"
}
}
}

Environments

An environment indicates the specific host where a build can be deployed, and whether the build should be deployed as a set of files or compressed in an archive format. In the Reactor API, environments are separate from hosts themselves, which are managed by the /hosts endpoint.

List a property's environments

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose environments you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
stage	string Filter by `stage`.
token	string Filter by `token`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/environments

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create an environment for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/environments

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"archive": true,
"archive_passphrase": "string",
"path": "string",
"stage": "string"
},
"relationships": {"host": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"archive": true,
"created_at": "string",
"library_path": "string",
"library_name": "string",
"library_entry_points": [{"library_name": "string",
"minified": true,
"references": ["string"
],
"license_path": "string"
}
],
"name": "string",
"path": "string",
"stage": "string",
"updated_at": "string",
"status": "string",
"token": "string"
},
"relationships": {"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"builds": {"links": {"related": "string"
}
},
"host": {"links": {"related": "string",
"self": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"archive_encrypted": true,
"script_sources": ["string"
]
}
}
}

Retrieve an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"archive": true,
"created_at": "string",
"library_path": "string",
"library_name": "string",
"library_entry_points": [{"library_name": "string",
"minified": true,
"references": ["string"
],
"license_path": "string"
}
],
"name": "string",
"path": "string",
"stage": "string",
"updated_at": "string",
"status": "string",
"token": "string"
},
"relationships": {"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"builds": {"links": {"related": "string"
}
},
"host": {"links": {"related": "string",
"self": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"archive_encrypted": true,
"script_sources": ["string"
]
}
}
}

Delete an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/environments/{ENVIRONMENT_ID}

Update an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

200

Success

patch/environments/{ENVIRONMENT_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"archive": true,
"archive_passphrase": "string",
"path": "string",
"include_debug_library": true
},
"relationships": {"host": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"archive": true,
"created_at": "string",
"library_path": "string",
"library_name": "string",
"library_entry_points": [{"library_name": "string",
"minified": true,
"references": ["string"
],
"license_path": "string"
}
],
"name": "string",
"path": "string",
"stage": "string",
"updated_at": "string",
"status": "string",
"token": "string"
},
"relationships": {"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"builds": {"links": {"related": "string"
}
},
"host": {"links": {"related": "string",
"self": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"archive_encrypted": true,
"script_sources": ["string"
]
}
}
}

List an environment's builds

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose related builds you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/builds

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List an environment's secrets

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose related secrets you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/secrets

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Retrieve a host

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose host you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/host

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"server": "string",
"name": "string",
"path": "string",
"port": 0,
"status": "string",
"skip_symlinks": true,
"type_of": "string",
"updated_at": "string",
"username": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Retrieve the host relationship for an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose host relationship you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/relationships/host

Response samples

application/vnd.api+json

{"data": [{"type": "string",
"id": "string"
}
],
"links": {"related": "string",
"self": "string"
}
}

Retrieve an environment's related library

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose related library you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/library

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"published_at": "string",
"state": "string",
"updated_at": "string",
"build_required": true,
"stale": "upstream_changed"
},
"relationships": {"builds": {"links": {"related": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"data_elements": {"links": {"related": "string",
"self": "string"
}
},
"extensions": {"links": {"related": "string",
"self": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string",
"self": "string"
}
},
"upstream_library": {"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"last_build": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"build_status": "string",
"build_required_detail": "string"
}
}
}

Retrieve the property that owns an environment

NOTE: For more information on using this operation, see the environments endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose related property you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/property

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Hosts

A host represents a hosted destination where a library build can be delivered and ultimately deployed. Hosts can be either Akamai or SFTP servers.

List a property's hosts

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose hosts you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
name	string Filter by `name`.
display_name	string Filter by `display_name`.
enabled	string Filter by `enabled`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.
version	string Filter by `version`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/hosts

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a host

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a host for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/hosts

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"type_of": "string",
"encrypted_private_key": "string",
"server": "string",
"skip_symlinks": true,
"path": "string",
"port": 0,
"username": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"server": "string",
"name": "string",
"path": "string",
"port": 0,
"status": "string",
"skip_symlinks": true,
"type_of": "string",
"updated_at": "string",
"username": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Retrieve a host

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

HOST_ID

required

string

The ID of the host you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/hosts/{HOST_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"server": "string",
"name": "string",
"path": "string",
"port": 0,
"status": "string",
"skip_symlinks": true,
"type_of": "string",
"updated_at": "string",
"username": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Delete a host

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

HOST_ID

required

string

The ID of the host you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/hosts/{HOST_ID}

Update a host

Only hosts with a type_of value of sftp may be updated.

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

HOST_ID

required

string

The ID of the host you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

200

Success

patch/hosts/{HOST_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"type_of": "string",
"encrypted_private_key": "string",
"server": "string",
"skip_symlinks": true,
"path": "string",
"port": 0,
"username": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"server": "string",
"name": "string",
"path": "string",
"port": 0,
"status": "string",
"skip_symlinks": true,
"type_of": "string",
"updated_at": "string",
"username": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Retrieve a host's property

NOTE: For more information on using this operation, see the hosts endpoint guide on Experience League.

Request

path Parameters

HOST_ID

required

string

The ID of the host whose property you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/hosts/{HOST_ID}/property

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Secrets

A secret is a resource that represents an authentication credential. Secrets are used in event forwarding to authenticate to another system for secure data exchange. Secrets can only be created within event forwarding properties (properties whose platform attribute is set to edge).

List a property's secrets

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose secrets you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
environment_id	string Filter by `environment_id`.
name	string Filter by `name`.
status	string Filter by `status`.
type_of	string Filter by `type`.
updated_at	string Filter by `updated_at` timestamp.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/properties/{PROPERTY_ID}/secrets

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a secret

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a secret for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes, relationships, and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/secrets

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"type_of": "string",
"credentials": { }
},
"relationships": {"environment": {"data": {"id": "string",
"type": "string"
}
}
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"name": "string",
"type_of": "string",
"activated_at": "string",
"expires_at": "string",
"refreshes_at": "string",
"status": "string",
"credentials": { }
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
},
"meta": {"stage": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"property": "string"
}
}
}

Retrieve a secret

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/secrets/{SECRET_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"name": "string",
"type_of": "string",
"activated_at": "string",
"expires_at": "string",
"refreshes_at": "string",
"status": "string",
"credentials": { }
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
},
"meta": {"stage": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"property": "string"
}
}
}

Delete a secret

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/secrets/{SECRET_ID}

Test or retry a secret

This call tests or retries a secret depending on the value of the meta.action property in the request payload. This call does not update the secret itself.

You can retry a secret by setting the action property to retry. Retrying a secret is the action of manually triggering the secret exchange.

If the secret in question is an oauth2 type, you can test it by setting the action property to test instead. This performs an exchange with the authorization service and includes the response in the test_exchange attribute in the secret’s meta object.

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret you want to test or retry.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Responses

200

Success

patch/secrets/{SECRET_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"type_of": "oauth2"
},
"meta": {"action": "test"
},
"id": "SE6c15a7a64f9041b5985558ed3e19a449",
"type": "secrets"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"name": "string",
"type_of": "string",
"activated_at": "string",
"expires_at": "string",
"refreshes_at": "string",
"status": "string",
"credentials": { }
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"environment": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
},
"meta": {"stage": "string"
}
},
"notes": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"property": "string"
}
}
}

List an environment's secrets

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

ENVIRONMENT_ID

required

string

The ID of the environment whose related secrets you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/environments/{ENVIRONMENT_ID}/secrets

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

List a secret's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/secrets/{SECRET_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a secret

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/secrets/{SECRET_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List the data elements that reference a secret

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret whose data elements you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
dirty	string Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
enabled	string Filter by `enabled`.
name	string Filter by `name`.
origin_id	string Filter by `origin_id`.
published	string Filter by `published` status.
published_at	string Filter by `published_at` timestamp.
revision_number	string Filter by `revision_number`.
updated_at	string Filter by `updated_at` timestamp.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/secrets/{SECRET_ID}/data_elements

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Retrieve a secret's environment

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret whose environment you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/secrets/{SECRET_ID}/environment

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"archive": true,
"created_at": "string",
"library_path": "string",
"library_name": "string",
"library_entry_points": [{"library_name": "string",
"minified": true,
"references": ["string"
],
"license_path": "string"
}
],
"name": "string",
"path": "string",
"stage": "string",
"updated_at": "string",
"status": "string",
"token": "string"
},
"relationships": {"library": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"builds": {"links": {"related": "string"
}
},
"host": {"links": {"related": "string",
"self": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
},
"meta": {"archive_encrypted": true,
"script_sources": ["string"
]
}
}
}

Retrieve a secret's property

NOTE: For more information on using this operation, see the secrets endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret whose property you want to retrieve.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/secrets/{SECRET_ID}/property

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"enabled": true,
"name": "string",
"updated_at": "string",
"platform": "string",
"development": true,
"token": "string",
"domains": ["string"
],
"undefined_vars_return_empty": true,
"rule_component_sequencing_enabled": true
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"callbacks": {"links": {"related": "string"
}
},
"hosts": {"links": {"related": "string"
}
},
"environments": {"links": {"related": "string"
}
},
"libraries": {"links": {"related": "string"
}
},
"data_elements": {"links": {"related": "string"
}
},
"extensions": {"links": {"related": "string"
}
},
"rules": {"links": {"related": "string"
}
},
"notes": {"links": {"related": "string"
}
}
},
"links": {"company": "string",
"data_elements": "string",
"environments": "string",
"extensions": "string",
"rules": "string",
"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

App configurations

App configurations allow credentials to be stored and retrieved for later use.

List a company's app configurations

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company whose app configurations you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
app_id	string Filter by `app_id`.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
key_type	string Filter by `key_type`.
messaging_service	string Filter by `messaging_service`.
name	string Filter by `name`.
platform	string Filter by `platform`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/companies/{COMPANY_ID}/app_configurations

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create an app configuration

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

COMPANY_ID

required

string

The ID of the company that you want to define the app configuration under.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/companies/{COMPANY_ID}/app_configurations

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"app_id": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string",
"push_credential": { }
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"app_id": "string",
"name": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string"
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"company": "string",
"self": "string"
}
}
}

Retrieve an app configuration

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

CONFIG_ID

required

string

The ID of the app configuration you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/app_configurations/{CONFIG_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"app_id": "string",
"name": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string"
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"company": "string",
"self": "string"
}
}
}

Delete an app configuration

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

CONFIG_ID

required

string

The ID of the app configuration you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/app_configurations/{CONFIG_ID}

Update an app configuration

NOTE: For more information on using this operation, see the app configurations endpoint guide on Experience League.

Request

path Parameters

CONFIG_ID

required

string

The ID of the app configuration you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

200

Success

patch/app_configurations/{CONFIG_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"name": "string",
"app_id": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string",
"push_credential": { }
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"updated_at": "string",
"app_id": "string",
"name": "string",
"platform": "string",
"messaging_service": "string",
"key_type": "string"
},
"relationships": {"company": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"company": "string",
"self": "string"
}
}
}

Retrieve the company that owns an app configuration

Request

path Parameters

CONFIG_ID

required

string

The ID of the app configuration whose company you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/app_configurations/{CONFIG_ID}/company

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"name": "string",
"org_id": "string",
"updated_at": "string",
"token": "string",
"cjm_enabled": true,
"edge_enabled": true,
"edge_events_allotment": 0,
"edge_fanout_ratio": 0,
"premium_cdn_enabled": true,
"sla_enabled": true
},
"relationships": {"properties": {"links": {"related": "string"
}
}
},
"links": {"self": "string",
"properties": "string"
},
"meta": {"rights": ["string"
],
"platform_rights": {"web": ["string"
],
"mobile": ["string"
]
}
}
}
}

Audit events

An audit event is a record of a specific change to another tag resource, generated at the time the change is made. These are system events which can be subscribed to through the use of a callback function.

List audit events

NOTE: For more information on using this operation, see the audit events endpoint guide on Experience League.

Request

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
type_of	string Filter by `type`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/audit_events

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Retrieve an audit event

NOTE: For more information on using this operation, see the audit events endpoint guide on Experience League.

Request

path Parameters

EVENT_ID

required

string

The ID of the audit event you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/audit_events/{EVENT_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"attributed_to_display_name": "string",
"attributed_to_email": "string",
"created_at": "string",
"display_name": "string",
"type_of": "string",
"updated_at": "string",
"entity": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
},
"entity": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"entity": "string",
"property": "string",
"self": "string"
}
}
}

Callbacks

A callback is a message that Platform sends to a URL host whenever a new audit event is generated.

List a property's callbacks

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose callbacks you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/callbacks

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a new callback

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a callback for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/callbacks

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"subscriptions": ["string"
],
"url": "string"
}
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"subscriptions": ["string"
],
"updated_at": "string",
"url": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Retrieve a callback

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

CALLBACK_ID

required

string

The ID of the callback you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/callbacks/{CALLBACK_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"subscriptions": ["string"
],
"updated_at": "string",
"url": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Delete a callback

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

CALLBACK_ID

required

string

The ID of the callback you want to delete.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

204

No content

delete/callbacks/{CALLBACK_ID}

Update a callback

NOTE: For more information on using this operation, see the callbacks endpoint guide on Experience League.

Request

path Parameters

CALLBACK_ID

required

string

The ID of the callback you want to update.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being updated.

Responses

200

Success

patch/callbacks/{CALLBACK_ID}

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"subscriptions": ["string"
],
"url": "string"
},
"id": "string",
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"created_at": "string",
"subscriptions": ["string"
],
"updated_at": "string",
"url": "string"
},
"relationships": {"property": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"property": "string",
"self": "string"
}
}
}

Notes

Notes are textual annotations that you can add to certain tag resources, such as data elements, extensions, libraries, properties, rules, and rule components.

Retrieve a note

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

NOTE_ID

required

string

The ID of the note you want to look up.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/notes/{NOTE_ID}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List a property's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/properties/{PROPERTY_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a property

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

PROPERTY_ID

required

string

The ID of the property that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/properties/{PROPERTY_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List a data element's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

DATA_ELEMENT_ID

required

string

The ID of the data element whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/data_elements/{DATA_ELEMENT_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a data element

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

DATA_ELEMENT_ID

required

string

The ID of the data element that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/data_elements/{DATA_ELEMENT_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List a secret's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.

Responses

200

Success

get/secrets/{SECRET_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a secret

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

SECRET_ID

required

string

The ID of the secret that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/secrets/{SECRET_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List an extension's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension whose notes you want to list.

query Parameters

page[size]

integer <= 100

Default: 25

Limits the number of results per page (for example, page[size]=50). Can be used in conjunction with page[number] to manage response pagination.

page[number]

integer

Default: 1

The page index to return for the listing response (for example, page[number]=2). Can be used in conjunction with page[size] to manage response pagination.

NOTE: Responses for listing calls contain a meta.pagination object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/extensions/{EXTENSION_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for an extension

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

EXTENSION_ID

required

string

The ID of the extension that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/extensions/{EXTENSION_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List a library's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/libraries/{LIBRARY_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a library

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

LIBRARY_ID

required

string

The ID of the library that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/libraries/{LIBRARY_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List a rule's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rules/{RULE_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a rule

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_ID

required

string

The ID of the rule that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/rules/{RULE_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

List a rule component's notes

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component whose notes you want to list.

query Parameters

page[size]	integer <= 100 Default: 25 Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
page[number]	integer Default: 1 The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination. NOTE: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.
created_at	string Filter by `created_at` timestamp.
updated_at	string Filter by `updated_at` timestamp.
text	string Filter by `text`.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/rule_components/{RULE_COMPONENT_ID}/notes

Response samples

application/vnd.api+json

{"data": [{ }
],
"meta": {"pagination": {"current_page": 0,
"next_page": 0,
"prev_page": 0,
"total_pages": 0,
"total_count": 0
}
}
}

Create a note for a rule component

NOTE: For more information on using this operation, see the notes endpoint guide on Experience League.

Request

path Parameters

RULE_COMPONENT_ID

required

string

The ID of the rule component that you want to create a note for.

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

required

object

Contains the attributes and type for the resource being created.

Responses

201

Success

post/rule_components/{RULE_COMPONENT_ID}/notes

Request samples

Payload

application/vnd.api+json

{"data": {"attributes": {"text": "string"
},
"type": "app_configurations"
}
}

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"author_display_name": "string",
"author_email": "string",
"created_at": "string",
"text": "string"
},
"relationships": {"resource": {"links": {"related": "string"
},
"data": {"id": "string",
"type": "string"
}
}
},
"links": {"resource": "string",
"self": "string"
}
}
}

Profiles

A profile represents a tags user. Platform does not maintain its own database of users and permissions, and instead relies on Adobe IDs managed by Adobe’s company-wide Identity Management System (IMS). A profile contains all the information about the logged-in user, including all the Adobe Orgs to which they belong, the product profiles they belong to within each Org, and the rights they have from each product profile.

Retrieve the details of the currently logged-in user

NOTE: For more information on using this operation, see the profile endpoint guide on Experience League.

Request

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Accept required	string All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).

Responses

200

Success

get/profile

Response samples

application/vnd.api+json

{"data": {"id": "string",
"type": "string",
"attributes": {"active_org": "string",
"expires_in": 0,
"display_name": "string",
"job_function": "string",
"email": "string",
"organizations": {"{ORG_ID}": {"name": "string",
"admin": true,
"active": true,
"login_companies": ["string"
],
"product_contexts": ["string"
],
"tenant_id": "string"
}
}
},
"links": {"self": "string"
},
"meta": {"rights": ["string"
]
}
}
}

Search

The search endpoint provides a way to find resources matching a desired criteria, expressed as a query. All queries are scoped to your current company and accessible properties.

Perform a search

The payload of a search request must contain a query object. This query object must contain at least one property whose key is a dot-notation path to the attribute being queried (e.g. attributes.name).

NOTE: For detailed information on how to construct a search payload, see the search endpoint guide on Experience League.

Request

header Parameters

Authorization required	string The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the authentication tutorial.
x-api-key required	string The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
x-gw-ims-org-id required	string The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the authentication tutorial.
Content-Type required	string This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.

Request Body schema: application/vnd.api+json
required

from	integer >= 0 The result set offset.
size	integer <= 100 The maximum number of results to return.
required	object Describes the search query as a structured JSON object.
	Array of objects Describes the order in which to sort results.
resource_types	Array of strings Lists the resource types to query. Only searchable resource type values can be included: `audit_events` `builds` `callbacks` `data_elements` `environments` `extension_packages` `extensions` `hosts` `libraries` `properties` `rule_components` `rules`

Responses

200

Success

post/search

Request samples

Payload

application/vnd.api+json

{"data": {"query": {"attributes.name": {"value": "Example"
}
}
}
}

Response samples

application/vnd.api+json

{"data": [{"id": "PRc2fa6dc3c4c74f8db63476eebfc31dc6",
"type": "properties",
"attributes": {"created_at": "2020-12-14T17:59:24.424Z",
"enabled": true,
"name": "Kessel Example Property",
"updated_at": "2020-12-14T17:59:24.424Z",
"platform": "web",
"development": false,
"token": "04c3cf57fe11",
"domains": ["example.com"
],
"undefined_vars_return_empty": false,
"rule_component_sequencing_enabled": false
},
"relationships": {"company": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/company"
},
"data": {"id": "CO2bf094214ffd4785bb4bcf88c952a7c1",
"type": "companies"
}
},
"callbacks": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/callbacks"
}
},
"hosts": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/hosts"
}
},
"environments": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/environments"
}
},
"libraries": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/libraries"
}
},
"data_elements": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/data_elements"
}
},
"extensions": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/extensions"
}
},
"rules": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/rules"
}
},
"notes": {"links": {"related": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/notes"
}
}
},
"links": {"company": "http://localhost:9010/companies/CO2bf094214ffd4785bb4bcf88c952a7c1",
"data_elements": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/data_elements",
"environments": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/environments",
"extensions": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/extensions",
"rules": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6/rules",
"self": "http://localhost:9010/properties/PRc2fa6dc3c4c74f8db63476eebfc31dc6"
},
"meta": {"match_score": 3.1645029
}
}
],
"meta": {"total_hits": 1
}
}

Get credentials

Reactor API (1.0)

(NEW) Interactive API documentation

Companies

List companies

query Parameters

header Parameters

Retrieve a company

path Parameters

header Parameters

List a company's properties

path Parameters

query Parameters

header Parameters

Create a new property

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

List a company's app configurations

path Parameters

query Parameters

header Parameters

Create an app configuration

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

Properties

List a company's properties

path Parameters

query Parameters

header Parameters

Create a new property

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

Retrieve a property

path Parameters

header Parameters

Delete a property

path Parameters

header Parameters

Update a property

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

Retrieve the company that owns a property

path Parameters

header Parameters

List a property's callbacks

path Parameters

query Parameters

header Parameters

Create a new callback

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

List a property's data elements

path Parameters

query Parameters

header Parameters

Create a data element

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

List a property's environments

path Parameters

query Parameters

header Parameters

Create an environment

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

List a property's extensions

path Parameters

query Parameters

header Parameters

Create an extension

path Parameters

header Parameters

Request Body schema: application/vnd.api+jsonrequired

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required

Request Body schema: application/vnd.api+json
required