{ "opencollection": "1.0.0", "info": { "name": "Reactor API", "version": "1.0" }, "items": [ { "info": { "name": "Companies", "type": "folder" }, "items": [ { "info": { "name": "List companies", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/companies", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "org_id", "value": "", "type": "query", "description": "Filter by `org_id`." }, { "name": "token", "value": "", "type": "query", "description": "Filter by `token`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [companies endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/companies.html) on Experience League." }, { "info": { "name": "Retrieve a company", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/companies/:COMPANY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "COMPANY_ID", "value": "", "type": "path", "description": "The ID of the company you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [companies endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/companies.html) on Experience League." }, { "info": { "name": "List a company's properties", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/companies/:COMPANY_ID/properties", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "COMPANY_ID", "value": "", "type": "path", "description": "The ID of the company whose properties you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "app_id", "value": "", "type": "query", "description": "Filter by `app_id`." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "copying", "value": "", "type": "query", "description": "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." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "platform", "value": "", "type": "query", "description": "Filter by `platform`." }, { "name": "token", "value": "", "type": "query", "description": "Filter by `token`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League." }, { "info": { "name": "Create a new property", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/companies/:COMPANY_ID/properties", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "COMPANY_ID", "value": "", "type": "path", "description": "The ID of the company that you want to define the property under." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League." }, { "info": { "name": "List a company's app configurations", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/companies/:COMPANY_ID/app_configurations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "COMPANY_ID", "value": "", "type": "path", "description": "The ID of the company whose app configurations you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "app_id", "value": "", "type": "query", "description": "Filter by `app_id`." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "key_type", "value": "", "type": "query", "description": "Filter by `key_type`." }, { "name": "messaging_service", "value": "", "type": "query", "description": "Filter by `messaging_service`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "platform", "value": "", "type": "query", "description": "Filter by `platform`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [app configurations endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/app-configurations.html) on Experience League." }, { "info": { "name": "Create an app configuration", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/companies/:COMPANY_ID/app_configurations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "COMPANY_ID", "value": "", "type": "path", "description": "The ID of the company that you want to define the app configuration under." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [app configurations endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/app-configurations.html) on Experience League." } ] }, { "info": { "name": "Properties", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a property", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League." }, { "info": { "name": "Update a property", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/properties/:PROPERTY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League." }, { "info": { "name": "Delete a property", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/properties/:PROPERTY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League." }, { "info": { "name": "Retrieve the company that owns a property", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/company", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose company you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [properties endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/properties.html) on Experience League." }, { "info": { "name": "List a property's callbacks", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/callbacks", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose callbacks you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League." }, { "info": { "name": "Create a new callback", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/callbacks", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a callback for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League." }, { "info": { "name": "List a property's data elements", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose data elements you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "published_at", "value": "", "type": "query", "description": "Filter by `published_at` timestamp." }, { "name": "published", "value": "", "type": "query", "description": "Filter by `published` status." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "origin_id", "value": "", "type": "query", "description": "Filter by `origin_id`." }, { "name": "revision_number", "value": "", "type": "query", "description": "Filter by `revision_number`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [data elements endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/data-elements.html) on Experience League." }, { "info": { "name": "Create a data element", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a data element for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [data elements endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/data-elements.html) on Experience League." }, { "info": { "name": "List a property's environments", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/environments", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose environments you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "stage", "value": "", "type": "query", "description": "Filter by `stage`." }, { "name": "token", "value": "", "type": "query", "description": "Filter by `token`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Create an environment", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/environments", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create an environment for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "List a property's extensions", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose extensions you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "display_name", "value": "", "type": "query", "description": "Filter by `display_name`." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "origin_id", "value": "", "type": "query", "description": "Filter by `origin_id`." }, { "name": "published", "value": "", "type": "query", "description": "Filter by `published` status." }, { "name": "published_at", "value": "", "type": "query", "description": "Filter by `published_at` timestamp." }, { "name": "revision_number", "value": "", "type": "query", "description": "Filter by `revision_number`." }, { "name": "version", "value": "", "type": "query", "description": "Filter by `version`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "Create an extension", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create an extension for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "List a property's hosts", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/hosts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose hosts you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "display_name", "value": "", "type": "query", "description": "Filter by `display_name`." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "origin_id", "value": "", "type": "query", "description": "Filter by `origin_id`." }, { "name": "published", "value": "", "type": "query", "description": "Filter by `published` status." }, { "name": "published_at", "value": "", "type": "query", "description": "Filter by `published_at` timestamp." }, { "name": "revision_number", "value": "", "type": "query", "description": "Filter by `revision_number`." }, { "name": "version", "value": "", "type": "query", "description": "Filter by `version`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [hosts endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/hosts.html) on Experience League." }, { "info": { "name": "Create a host", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/hosts", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a host for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [hosts endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/hosts.html) on Experience League." }, { "info": { "name": "List a property's libraries", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/libraries", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose libraries you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "stale", "value": "", "type": "query", "description": "Filter by `stale` status. A library becomes stale when another library on the [upstream](https://experienceleague.adobe.com/docs/experience-platform/tags/publish/publishing-flow.html#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." }, { "name": "state", "value": "", "type": "query", "description": "Filter by `state`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Create a library", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/libraries", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a library for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a property's rules", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose rules you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "dirty", "value": "", "type": "query", "description": "Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library)." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "origin_id", "value": "", "type": "query", "description": "Filter by `origin_id`." }, { "name": "published", "value": "", "type": "query", "description": "Filter by `published` status." }, { "name": "published_at", "value": "", "type": "query", "description": "Filter by `published_at` timestamp." }, { "name": "revision_number", "value": "", "type": "query", "description": "Filter by `revision_number`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a rule", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a rule for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." }, { "info": { "name": "List a property's secrets", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/secrets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose secrets you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "environment_id", "value": "", "type": "query", "description": "Filter by `environment_id`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "status", "value": "", "type": "query", "description": "Filter by `status`." }, { "name": "type_of", "value": "", "type": "query", "description": "Filter by `type`." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." } ] }, "docs": ">**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." }, { "info": { "name": "Create a secret", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/secrets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a secret for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." }, { "info": { "name": "List a property's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for a property", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/properties/:PROPERTY_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "PROPERTY_ID", "value": "", "type": "path", "description": "The ID of the property that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." } ] }, { "info": { "name": "App configurations", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an app configuration", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/app_configurations/:CONFIG_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "CONFIG_ID", "value": "", "type": "path", "description": "The ID of the app configuration you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [app configurations endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/app-configurations.html) on Experience League." }, { "info": { "name": "Update an app configuration", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/app_configurations/:CONFIG_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "CONFIG_ID", "value": "", "type": "path", "description": "The ID of the app configuration you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [app configurations endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/app-configurations.html) on Experience League." }, { "info": { "name": "Delete an app configuration", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/app_configurations/:CONFIG_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "CONFIG_ID", "value": "", "type": "path", "description": "The ID of the app configuration you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [app configurations endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/app-configurations.html) on Experience League." }, { "info": { "name": "Retrieve the company that owns an app configuration", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/app_configurations/:CONFIG_ID/company", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "CONFIG_ID", "value": "", "type": "path", "description": "The ID of the app configuration whose company you want to look up." } ] }, "docs": "Retrieve the company that owns an app configuration" } ] }, { "info": { "name": "Callbacks", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a callback", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/callbacks/:CALLBACK_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "CALLBACK_ID", "value": "", "type": "path", "description": "The ID of the callback you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League." }, { "info": { "name": "Update a callback", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/callbacks/:CALLBACK_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "CALLBACK_ID", "value": "", "type": "path", "description": "The ID of the callback you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League." }, { "info": { "name": "Delete a callback", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/callbacks/:CALLBACK_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "CALLBACK_ID", "value": "", "type": "path", "description": "The ID of the callback you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [callbacks endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/callbacks.html) on Experience League." } ] }, { "info": { "name": "Data elements", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a data element", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/data_elements/:DATA_ELEMENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "DATA_ELEMENT_ID", "value": "", "type": "path", "description": "The ID of the data element you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [data elements endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/data-elements.html) on Experience League." }, { "info": { "name": "Update a data element", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/data_elements/:DATA_ELEMENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "DATA_ELEMENT_ID", "value": "", "type": "path", "description": "The ID of the data element you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nYou 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" }, { "info": { "name": "List a data element's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/data_elements/:DATA_ELEMENT_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "DATA_ELEMENT_ID", "value": "", "type": "path", "description": "The ID of the data element whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for a data element", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/data_elements/:DATA_ELEMENT_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "DATA_ELEMENT_ID", "value": "", "type": "path", "description": "The ID of the data element that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." } ] }, { "info": { "name": "Environments", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an environment", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Update an environment", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Delete an environment", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "List an environment's builds", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID/builds", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment whose related builds you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Retrieve a host", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID/host", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment whose host you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Retrieve the host relationship for an environment", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID/relationships/host", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment whose host relationship you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Retrieve an environment's related library", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID/library", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment whose related library you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." }, { "info": { "name": "Retrieve the property that owns an environment", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID/property", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment whose related property you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [environments endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/environments.html) on Experience League." } ] }, { "info": { "name": "Secrets", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a secret", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/secrets/:SECRET_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret you want to look up." } ] }, "docs": ">**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." }, { "info": { "name": "Test or retry a secret", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/secrets/:SECRET_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret you want to test or retry." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n\nYou can retry a secret by setting the `action` property to `retry`. Retrying a secret is the action of manually triggering the secret exchange.\n\n\nIf 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 respo" }, { "info": { "name": "Delete a secret", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/secrets/:SECRET_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret you want to delete." } ] }, "docs": ">**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." }, { "info": { "name": "List an environment's secrets", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/environments/:ENVIRONMENT_ID/secrets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "ENVIRONMENT_ID", "value": "", "type": "path", "description": "The ID of the environment whose related secrets you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**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." }, { "info": { "name": "List a secret's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/secrets/:SECRET_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for a secret", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/secrets/:SECRET_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." }, { "info": { "name": "List the data elements that reference a secret", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/secrets/:SECRET_ID/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret whose data elements you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "dirty", "value": "", "type": "query", "description": "Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library)." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "origin_id", "value": "", "type": "query", "description": "Filter by `origin_id`." }, { "name": "published", "value": "", "type": "query", "description": "Filter by `published` status." }, { "name": "published_at", "value": "", "type": "query", "description": "Filter by `published_at` timestamp." }, { "name": "revision_number", "value": "", "type": "query", "description": "Filter by `revision_number`." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." } ] }, "docs": ">**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." }, { "info": { "name": "Retrieve a secret's environment", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/secrets/:SECRET_ID/environment", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret whose environment you want to retrieve." } ] }, "docs": ">**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." }, { "info": { "name": "Retrieve a secret's property", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/secrets/:SECRET_ID/property", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "SECRET_ID", "value": "", "type": "path", "description": "The ID of the secret whose property you want to retrieve." } ] }, "docs": ">**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." } ] }, { "info": { "name": "Extension packages", "type": "folder" }, "items": [ { "info": { "name": "List extension packages", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extension_packages", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "display_name", "value": "", "type": "query", "description": "Filter by `display_name`." }, { "name": "status", "value": "", "type": "query", "description": "Filter by `status`." }, { "name": "platform", "value": "", "type": "query", "description": "Filter by `platform`." }, { "name": "version", "value": "", "type": "query", "description": "Filter by `version`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Create an extension package", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/extension_packages", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "multipart-form", "data": [ { "name": "package", "type": "text", "value": "" } ] } }, "docs": ">**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](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Retrieve an extension package", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extension_packages/:EXTENSION_PACKAGE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_ID", "value": "", "type": "path", "description": "The ID of the extension package you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Update an extension package", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/extension_packages/:EXTENSION_PACKAGE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_ID", "value": "", "type": "path", "description": "The ID of the development extension package you want to update." } ], "body": { "type": "multipart-form", "data": [ { "name": "package", "type": "text", "value": "" } ] } }, "docs": "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.\n\n>**NOTE**: For more informa" }, { "info": { "name": "Privately release or discontinue an extension package", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/extension_packages/:EXTENSION_PACKAGE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_ID", "value": "", "type": "path", "description": "The ID of the development extension package you want to privately release or discontinue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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](https://adobe.allegiancetech.com/cgi-bin/qwebcorporate.dll?idx=7DRB5U).\n \n\nWhen privately releasing or discontinuing an extension package, its ID must be provided in both the request path and the request payload. These IDs mu" }, { "info": { "name": "Retrieve an extension package's versions", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extension_packages/:EXTENSION_PACKAGE_ID/versions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_ID", "value": "", "type": "path", "description": "The ID of the extension package whose versions you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." } ] }, { "info": { "name": "Extension package usage authorization", "type": "folder" }, "items": [ { "info": { "name": "Retrieve extension package usage authorizations for an extension package", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extension_packages/:EXTENSION_PACKAGE_ID/extension_package_usage_authorizations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_ID", "value": "", "type": "path", "description": "The ID of the extension package you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Create an extension package usage authorization", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/extension_packages/:EXTENSION_PACKAGE_ID/extension_package_usage_authorizations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_ID", "value": "", "type": "path", "description": "The ID of the extension package you want to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Retrieve a list of extension package usage authorizations", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extension_package_usage_authorizations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Update an extension package usage authorization", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/extension_package_usage_authorizations/:ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "ID", "value": "", "type": "path", "description": "The ID of the extension package usage authorization you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." }, { "info": { "name": "Delete an extension package usage authorization", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/extension_package_usage_authorizations/:ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "ID", "value": "", "type": "path", "description": "The ID of the extension package usage authorization you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "Retrieve data for the extension package for an extension package usage authorization", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extension_package_usage_authorizations/:EXTENSION_PACKAGE_USAGE_AUTHORIZATION_ID/extension_package", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_PACKAGE_USAGE_AUTHORIZATION_ID", "value": "", "type": "path", "description": "The ID of the extension package usage authorization you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extension packages endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extension-packages.html) on Experience League." } ] }, { "info": { "name": "Extensions", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an extension", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "Revise an extension", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension you want to revise." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nWhen 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.\n\n\n>**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/ex" }, { "info": { "name": "Delete an extension", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "Retrieve the extension package for an extension", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/extension_package", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension whose extension package you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "List the libraries that use an extension", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/libraries", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension whose libraries you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "Retrieve an extension's property", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/property", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension whose property you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "Retrieve an extension's origin", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/origin", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension whose origin you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "List an extension's revisions", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/revisions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension whose revisions you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [extensions endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/extensions.html) on Experience League." }, { "info": { "name": "List an extension's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for an extension", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/extensions/:EXTENSION_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "EXTENSION_ID", "value": "", "type": "path", "description": "The ID of the extension that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." } ] }, { "info": { "name": "Hosts", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a host", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/hosts/:HOST_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "HOST_ID", "value": "", "type": "path", "description": "The ID of the host you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [hosts endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/hosts.html) on Experience League." }, { "info": { "name": "Update a host", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/hosts/:HOST_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "HOST_ID", "value": "", "type": "path", "description": "The ID of the host you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Only hosts with a `type_of` value of `sftp` may be updated.\n\n>**NOTE**: For more information on using this operation, see the [hosts endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/hosts.html) on Experience League." }, { "info": { "name": "Delete a host", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/hosts/:HOST_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "HOST_ID", "value": "", "type": "path", "description": "The ID of the host you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [hosts endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/hosts.html) on Experience League." }, { "info": { "name": "Retrieve a host's property", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/hosts/:HOST_ID/property", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "HOST_ID", "value": "", "type": "path", "description": "The ID of the host whose property you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [hosts endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/hosts.html) on Experience League." } ] }, { "info": { "name": "Libraries", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a library", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Update a library", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This endpoint allows you to update the name of a library, or transition the library between different states in the [publishing flow](https://experienceleague.adobe.com/docs/launch/using/publish/publishing-flow.html).\n\nWhen 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.\n\nTo transition the library between states, the payload must include a `meta` object, containing a single `action` propert" }, { "info": { "name": "Delete a library", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library you want to delete." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Retrieve a library's property", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/property", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose related property you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Create a build", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/builds", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to create a build for." } ] }, "docs": "This POST request does not accept a payload, as the build parameters are determined by the parent library.\n\n>**NOTE**: For more information on using this operation, see the [builds endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/builds.html) on Experience League." }, { "info": { "name": "Retrieve a library's related environment", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/environment", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose related environment you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Retrieve a library's upstream library", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/upstream_library", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose upstream library you want to retrieve." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's related data elements", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose related data elements you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's data element relationships", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose data element relationships you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Add data elements to a specific library.", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to add data elements to." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Replace all data element relationships for a specific library", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to replace a data element relationship for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This call replaces all of the existing data element relationships for a library with those you provide in the payload array.\n\n>**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Remove a library's data element relationships", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/data_elements", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to remove a data element relationship from." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Retrieve a library's environment relationship", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/environment", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose environment relationship you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Set a library's environment relationship", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/environment", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to set an environment relationship for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Remove a library's environment relationship", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/environment", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to remove an environment relationship from." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's related extensions", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose related extensions you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's extension relationships", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose extension relationships you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Add extensions to a specific library", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to add extensions to." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Replace all extensions for a specific library", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose extensions you want to replace." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This call replaces all of the existing extension relationships for a library with those you provide in the payload array.\n\n>**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Remove a library's extensions", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/extensions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to remove extensions from." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's related rules", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose related rules you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's rule relationships", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose rule relationships you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Add rules to a specific library", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to add rules to." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Replace all rules for a specific library", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose rules you want to replace." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This call replaces all of the existing rule relationships for a library with those you provide in the payload array.\n\n>**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "Remove a library's rules", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/relationships/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to remove rules from." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**NOTE**: For more information on using this operation, see the [libraries endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/libraries.html) on Experience League." }, { "info": { "name": "List a library's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for a library", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." } ] }, { "info": { "name": "Builds", "type": "folder" }, "items": [ { "info": { "name": "List a library's builds", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/libraries/:LIBRARY_ID/builds", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "LIBRARY_ID", "value": "", "type": "path", "description": "The ID of the library whose builds you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "status", "value": "", "type": "query", "description": "Filter by `status`." }, { "name": "token", "value": "", "type": "query", "description": "Filter by `token`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [builds endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/builds.html) on Experience League." }, { "info": { "name": "Look up a build by ID.", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/builds/:BUILD_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "BUILD_ID", "value": "", "type": "path", "description": "The ID of the build you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [builds endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/builds.html) on Experience League." }, { "info": { "name": "Republish a build", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/builds/:BUILD_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "BUILD_ID", "value": "", "type": "path", "description": "The ID of the build you want to republish." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n>**NOTE**: For more information on using this operation, see the [builds endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/builds.html) on Experience League." } ] }, { "info": { "name": "Rules", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a rule", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule you want to look up." } ] }, "docs": ">**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." }, { "info": { "name": "Update a rule", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/rules/:RULE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\nWhen updating or revising a rule, its ID must be provided in both the request path and the request payload. These IDs" }, { "info": { "name": "Delete a rule", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/rules/:RULE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule you want to delete." } ] }, "docs": ">**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." }, { "info": { "name": "List a rule's components", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/rule_components", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose rule components you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "dirty", "value": "", "type": "query", "description": "Filter by `dirty` (whether the resource contains changes that haven't been pushed to a library)." }, { "name": "enabled", "value": "", "type": "query", "description": "Filter by `enabled`." }, { "name": "name", "value": "", "type": "query", "description": "Filter by `name`." }, { "name": "negate", "value": "", "type": "query", "description": "Filter by `negate` (whether the rule component represents a negation)." }, { "name": "origin_id", "value": "", "type": "query", "description": "Filter by `origin_id`." }, { "name": "published", "value": "", "type": "query", "description": "Filter by `published` status." }, { "name": "published_at", "value": "", "type": "query", "description": "Filter by `published_at` timestamp." }, { "name": "revision_number", "value": "", "type": "query", "description": "Filter by `revision_number`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a new rule component", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/rules/:RULE_ID/rule_components", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule that you want to create a rule component for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." }, { "info": { "name": "List all libraries that use a specific rule", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/libraries", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose related libraries you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**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." }, { "info": { "name": "Retrieve the property that owns a specific rule", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/property", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose property you want to look up." } ] }, "docs": ">**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." }, { "info": { "name": "Retrieve a rule's related origin", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/origin", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose origin you want to look up." } ] }, "docs": ">**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." }, { "info": { "name": "List a rule's revisions", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/revisions", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose revisions you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." } ] }, "docs": ">**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." }, { "info": { "name": "List the notes for a rule's components", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/rule_component_notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose rule component notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "List a rule's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rules/:RULE_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for a rule", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/rules/:RULE_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "RULE_ID", "value": "", "type": "path", "description": "The ID of the rule that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." } ] }, { "info": { "name": "Rule components", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a rule component", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component you want to look up." } ] }, "docs": ">**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." }, { "info": { "name": "Update a rule component", "type": "http" }, "http": { "method": "PATCH", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component you want to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n\n>**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." }, { "info": { "name": "Delete a rule component", "type": "http" }, "http": { "method": "DELETE", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component you want to delete." } ] }, "docs": ">**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." }, { "info": { "name": "Look up the extension that provides a specific rule component.", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID/extension", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component whose extension you want to look up." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Retrieve a rule component's origin", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID/origin", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component whose origin you want to look up." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "List the rules that utilize a rule component", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID/rules", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component whose related rules you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "List a rule component's notes", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component whose notes you want to list." }, { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "text", "value": "", "type": "query", "description": "Filter by `text`." } ] }, "docs": ">**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." }, { "info": { "name": "Create a note for a rule component", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/rule_components/:RULE_COMPONENT_ID/notes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "RULE_COMPONENT_ID", "value": "", "type": "path", "description": "The ID of the rule component that you want to create a note for." } ], "body": { "type": "json", "data": "{}" } }, "docs": ">**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." } ] }, { "info": { "name": "Notes", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a note", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/notes/:NOTE_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "NOTE_ID", "value": "", "type": "path", "description": "The ID of the note you want to look up." } ] }, "docs": ">**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." } ] }, { "info": { "name": "Audit events", "type": "folder" }, "items": [ { "info": { "name": "List audit events", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/audit_events", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "page[size]", "value": "", "type": "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." }, { "name": "page[number]", "value": "", "type": "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.\n>**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." }, { "name": "created_at", "value": "", "type": "query", "description": "Filter by `created_at` timestamp." }, { "name": "updated_at", "value": "", "type": "query", "description": "Filter by `updated_at` timestamp." }, { "name": "type_of", "value": "", "type": "query", "description": "Filter by `type`." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [audit events endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/audit-events.html) on Experience League." }, { "info": { "name": "Retrieve an audit event", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/audit_events/:EVENT_ID", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "EVENT_ID", "value": "", "type": "path", "description": "The ID of the audit event you want to look up." } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [audit events endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/audit-events.html) on Experience League." } ] }, { "info": { "name": "Profiles", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the details of the currently logged-in user", "type": "http" }, "http": { "method": "GET", "url": "//reactor.adobe.io/profile", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Accept", "value": "" } ] }, "docs": ">**NOTE**: For more information on using this operation, see the [profile endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/profile.html) on Experience League." } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Perform a search", "type": "http" }, "http": { "method": "POST", "url": "//reactor.adobe.io/search", "headers": [ { "name": "Authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-gw-ims-org-id", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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`).\n>**NOTE**: For detailed information on how to construct a search payload, see the [search endpoint guide](https://experienceleague.adobe.com/docs/experience-platform/tags/api/endpoints/search.html) on Experience League." } ] } ], "bundled": true }