Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Adobe Launch Rules API
version: '1.0'
description: 'Operations tagged Rules across 2 of this provider''s published API definitions: adobe-launch-reactor-api-published-openapi.yml, adobe-launch-rules-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: //reactor.adobe.io
- url: https://reactor.adobe.io
description: Adobe Reactor API production gateway
tags:
- name: Rules
description: 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.
paths:
/properties/{PROPERTY_ID}/rules:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: List a property's rules
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: listRules
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property whose rules you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: dirty
in: query
description: Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
schema:
type: string
- name: enabled
in: query
description: Filter by `enabled`.
schema:
type: string
- name: name
in: query
description: Filter by `name`.
schema:
type: string
- name: origin_id
in: query
description: Filter by `origin_id`.
schema:
type: string
- name: published
in: query
description: Filter by `published` status.
schema:
type: string
- name: published_at
in: query
description: Filter by `published_at` timestamp.
schema:
type: string
- name: revision_number
in: query
description: Filter by `revision_number`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns an array of rules belonging to the specified property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesListResponse'
post:
tags:
- Rules
summary: Create a rule
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: createRule
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property that you want to create a rule for.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesCreateResponse'
x-codegen-request-body-name: body
/rules/{RULE_ID}:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: Retrieve a rule
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: retrieveRule
parameters:
- name: RULE_ID
in: path
description: The ID of the rule you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesLookupResponse'
delete:
tags:
- Rules
summary: Delete a rule
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: deleteRule
parameters:
- name: RULE_ID
in: path
description: The ID of the rule you want to delete.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
responses:
'204':
x-summary: No content
description: A successful response returns HTTP status 204 (No Content).
content: {}
patch:
tags:
- Rules
summary: Update a rule
description: '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](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: updateRule
parameters:
- name: RULE_ID
in: path
description: The ID of the rule you want to update.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesUpdatePayload'
required: true
responses:
'200':
x-summary: Success
description: A successful response returns the details of the new revision for the rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesUpdateResponse'
x-codegen-request-body-name: body
/rules/{RULE_ID}/rule_components:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: List a rule's components
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: listRuleComponents
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose rule components you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
- name: created_at
in: query
description: Filter by `created_at` timestamp.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
- name: dirty
in: query
description: Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library).
schema:
type: string
- name: enabled
in: query
description: Filter by `enabled`.
schema:
type: string
- name: name
in: query
description: Filter by `name`.
schema:
type: string
- name: negate
in: query
description: Filter by `negate` (whether the rule component represents a negation).
schema:
type: string
- name: origin_id
in: query
description: Filter by `origin_id`.
schema:
type: string
- name: published
in: query
description: Filter by `published` status.
schema:
type: string
- name: published_at
in: query
description: Filter by `published_at` timestamp.
schema:
type: string
- name: revision_number
in: query
description: Filter by `revision_number`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns a list of rule components attached to the rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsListResponse'
post:
tags:
- Rules
summary: Create a new rule component
description: '>**NOTE**: For more information on using this operation, see the [rule components endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rule-components.html) on Experience League.'
operationId: createRuleComponent
parameters:
- name: RULE_ID
in: path
description: The ID of the rule that you want to create a rule component for.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Content-Type
in: header
description: This header must be provided with a value of `application/vnd.api+json` on all requests that contain a JSON payload.
required: true
schema:
type: string
requestBody:
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created rule component.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ruleComponentsCreateResponse'
x-codegen-request-body-name: body
/rules/{RULE_ID}/libraries:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: List all libraries that use a specific rule
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: listRuleLibraries
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose related libraries you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
responses:
'200':
x-summary: Success
description: A successful response returns an array of libraries related to the specified rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesLibrariesListResponse'
/rules/{RULE_ID}/property:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: Retrieve the property that owns a specific rule
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: retrieveRuleProperty
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose property you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the specified rule's property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesPropertyLookupResponse'
/rules/{RULE_ID}/origin:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: Retrieve a rule's related origin
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: retrieveRuleOrigin
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose origin you want to look up.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the specified rule's origin.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesOriginLookupResponse'
/rules/{RULE_ID}/revisions:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: List a rule's revisions
description: '>**NOTE**: For more information on using this operation, see the [rules endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: listRuleRevisions
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose revisions you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
responses:
'200':
x-summary: Success
description: A successful response returns an array of revisions for the specified rule.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/rulesRevisionsListResponse'
/rules/{RULE_ID}/rule_component_notes:
servers:
- url: //reactor.adobe.io
get:
tags:
- Rules
summary: List the notes for a rule's components
description: '>**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](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/rules.html) on Experience League.'
operationId: listRulesComponentsNotes
parameters:
- name: RULE_ID
in: path
description: The ID of the rule whose rule component notes you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organ
# --- truncated at 32 KB (101 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-launch/refs/heads/main/openapi/adobe-launch-rules-api-openapi.yml