Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Reactor Secrets API
description: "Use the Reactor API to programmatically manage resources and develop tag extensions in Adobe Experience Platform.\n**Related documentation**:\n * [Tags overview and UI documentation](https://adobe.com/go/launch_help_en)\n * [Reactor API guides](https://adobe.com/go/reactor-api-overview)\n\n**API paths**:\n * Reactor Gateway URL: https://<span>reactor.adobe.io\n * Example of a complete path for making a call to `/properties`: https://<span>reactor.adobe.io/properties\n\n**Required headers**:\n * 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](http://www.adobe.com/go/launch-authentication-en).\n * 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`).\n * 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.\n\n- **API error handling**:\n - Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors)."
version: '1.0'
servers:
- url: //reactor.adobe.io
tags:
- name: Secrets
description: 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`).
paths:
/properties/{PROPERTY_ID}/secrets:
get:
tags:
- Secrets
summary: List a property's secrets
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: listPropertySecrets
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property whose secrets you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: 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: environment_id
in: query
description: Filter by `environment_id`.
schema:
type: string
- name: name
in: query
description: Filter by `name`.
schema:
type: string
- name: status
in: query
description: Filter by `status`.
schema:
type: string
- name: type_of
in: query
description: Filter by `type`.
schema:
type: string
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns an array of secrets belonging to the specified property.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsListResponse'
post:
tags:
- Secrets
summary: Create a secret
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: createSecret
parameters:
- name: PROPERTY_ID
in: path
description: The ID of the property that you want to create a secret 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/secretsCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsCreateResponse'
x-codegen-request-body-name: body
/secrets/{SECRET_ID}:
get:
tags:
- Secrets
summary: Retrieve a secret
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: retrieveSecret
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret 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 secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsLookupResponse'
delete:
tags:
- Secrets
summary: Delete a secret
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: deleteSecret
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret 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:
- Secrets
summary: Test or retry a secret
description: '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](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: testOrRetrySecret
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret you want to test or retry.
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/secretsUpdatePayload'
required: true
responses:
'200':
x-summary: Success
description: A successful response returns the details of the updated secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsUpdateResponse'
x-codegen-request-body-name: body
/environments/{ENVIRONMENT_ID}/secrets:
get:
tags:
- Secrets
summary: List an environment's secrets
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: listEnvironmentSecrets
parameters:
- name: ENVIRONMENT_ID
in: path
description: The ID of the environment whose related secrets you want to list.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: Accept
in: header
description: All GET requests must include this header with the value of `application/vnd.api+json;revision=#` (where `#` is the revision number of the resource you want to retrieve, e.g. `1`).
required: true
schema:
type: string
- name: page[size]
in: query
description: Limits the number of results per page (for example, `page[size]=50`). Can be used in conjunction with `page[number]` to manage response pagination.
schema:
maximum: 100
type: integer
default: 25
- name: page[number]
in: query
description: 'The page index to return for the listing response (for example, `page[number]=2`). Can be used in conjunction with `page[size]` to manage response pagination.
>**NOTE**: Responses for listing calls contain a `meta.pagination` object which contains the indexes for the current, previous, and next pages in the response. To access these pages, use their index values for this parameter in subsequent API calls.'
schema:
type: integer
default: 1
responses:
'200':
x-summary: Success
description: A successful response returns an array of secrets that are associated with the specified environment.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/environmentsSecretsListResponse'
/secrets/{SECRET_ID}/notes:
get:
tags:
- Secrets
summary: List a secret's notes
description: '>**NOTE**: For more information on using this operation, see the [notes endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/notes.html) on Experience League.'
operationId: listSecretNotes
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret whose notes 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: 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: text
in: query
description: Filter by `text`.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns an array of notes belonging to the specified secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsNotesListResponse'
post:
tags:
- Secrets
summary: Create a note for a secret
description: '>**NOTE**: For more information on using this operation, see the [notes endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/notes.html) on Experience League.'
operationId: createSecretNote
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret that you want to create a note 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/secretsNotesCreatePayload'
required: true
responses:
'201':
x-summary: Success
description: A successful response returns the details of the newly created note.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsNotesCreateResponse'
x-codegen-request-body-name: body
/secrets/{SECRET_ID}/data_elements:
get:
tags:
- Secrets
summary: List the data elements that reference a secret
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: listSecretDataElements
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret whose data elements 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: 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: 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
- name: updated_at
in: query
description: Filter by `updated_at` timestamp.
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns an array of data elements that use the specified secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsDataElementsListResponse'
/secrets/{SECRET_ID}/environment:
get:
tags:
- Secrets
summary: Retrieve a secret's environment
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: retrieveSecretEnvironment
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret whose environment you want to retrieve.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the environment that the secret is associated with.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsLookupEnvironmentResponse'
/secrets/{SECRET_ID}/property:
get:
tags:
- Secrets
summary: Retrieve a secret's property
description: '>**NOTE**: For more information on using this operation, see the [secrets endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/secrets.html) on Experience League.'
operationId: retrieveSecretProperty
parameters:
- name: SECRET_ID
in: path
description: The ID of the secret whose property you want to retrieve.
required: true
schema:
type: string
- name: Authorization
in: header
description: The access token generated using your Organization ID, Client ID, and JavaScript Web Token (JWT), prefixed with `bearer`. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The Client ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The Organization ID which can be copied from Adobe Developer Console. For more information on how to obtain this value, see the [authentication tutorial](http://www.adobe.com/go/launch-authentication-en).
required: true
schema:
type: string
responses:
'200':
x-summary: Success
description: A successful response returns the details of the property that owns the secret.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/secretsPropertyLookupResponse'
components:
schemas:
propertiesLookupResponse:
allOf:
- $ref: '#/components/schemas/dataLookup'
- type: object
properties:
data:
type: object
allOf:
- $ref: '#/components/schemas/propertiesEntity'
secretsPropertyLookupResponse:
allOf:
- $ref: '#/components/schemas/propertiesLookupResponse'
metaList:
type: object
properties:
meta:
type: object
properties:
pagination:
type: object
properties:
current_page:
type: integer
description: The current page of the response.
next_page:
type: integer
description: The next page of the response.
prev_page:
type: integer
description: The previous page of the response.
total_pages:
type: integer
description: The total number of pages in the response.
total_count:
type: integer
description: The total number of results in
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-secrets-api-openapi.yml