Retrieve a destination configuration
This page exemplifies the API request and payload that you can use to retrieve information about an existing destination configuration, using the /authoring/destination
API endpoint.
Getting started with destination configuration API operations get-started
Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including how to obtain the required destination authoring permission and required headers.
Retrieve a destination configuration retrieve
You can retrieve an existing destination configuration by making a GET
request to the /authoring/destination
endpoint.
platform.adobe.io/data/core/activation/authoring/destinations
API format
Use the following API format to retrieve all destination configurations for your account.
GET /authoring/destinations
Use the following API format to retrieve a specific destination configuration, defined by the {INSTANCE_ID}
parameter.
GET /authoring/destinations/{INSTANCE_ID}
The following two requests retrieve all destination configurations for your IMS Organization, or a specific destination configuration, depending on whether you pass the INSTANCE_ID
parameter in the request.
Select each tab below to view the corresponding payload.
accordion | ||
---|---|---|
Request | ||
|
accordion | ||
---|---|---|
Response | ||
A successful response returns HTTP status 200 with a list of destination configurations that you have access to, based on the IMS Org ID and sandbox name that you used. One
|
accordion | ||||||||
---|---|---|---|---|---|---|---|---|
Request | ||||||||
|
accordion | ||
---|---|---|
Response | ||
A successful response returns HTTP status 200 with the details of the destination configuration corresponding to the
|
API error handling error-handling
Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide.
Next steps
After reading this document, you now know how to retrieve a destination configuration through the Destination SDK /authoring/destinations
API endpoint.
To learn more about what you can do with this endpoint, see the following articles: