Get Credentials

Get credentials

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

Data Distiller Authorization API (1.0.0)

Download OpenAPI specification:Download

Use the Adobe Experience Platform Data Distiller Authorization API to manage IP-based access restrictions for Query Service by controlling which IP addresses are allowed. With this tool, you can configure, enforce, and monitor IP-based restrictions to meet stringent security standards within Adobe Experience Platform.

NOTE: This functionality is only available to customers who have purchased the Data Distiller add on. For more information, contact your Adobe representative.

Related Documentation:

API paths:

  • PLATFORM Gateway URL: https://platform.adobe.io/
  • Base path for this API: /data/foundation/query/security
  • Example of a complete path: https://platform.adobe.io/data/foundation/query/security/ip-access

Required headers:

  • All calls require the headers Authorization, x-gw-ims-org-id, and x-api-key. For more information on obtaining these values, see the authentication tutorial.
  • All requests to Platform APIs require the header x-sandbox-name specifying the lowercase sandbox name where the operation will take place (for example, "prod"). For more details, see the sandboxes overview.
  • All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header Content-Type set to application/json.

API error handling:

(NEW) Interactive API documentation

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

IP Access

Use the IP Access endpoints to manage allowed IP ranges, enabling secure data access for Query Service in Adobe Experience Platform.

Retrieve all allowed IP ranges for a sandbox

Request
header Parameters
Authorization
required
string

The bearer token for authorization.

x-gw-ims-org-id
required
string

The organization ID for Adobe Experience Platform.

x-api-key
required
string

The API key for Adobe Experience Platform.

x-sandbox-name
required
string

The name of the sandbox where the operation will take place.

Accept-Encoding
string
Default: identity

The type of response encoding expected. The supported values are gzip and identity.

Enum: "gzip" "identity"
Responses
200

Success

401

Unauthorized

404

Not Found

500

Internal Server Error

get/security/ip-access
Response samples
application/json
{
  • "imsOrg": "18D63B2559DF0C130A49422D@AdobeOrg",
  • "sandboxName": "prod",
  • "channel": "data_distiller",
  • "allowedIpRanges": [
    ]
}

Set new allowed IP ranges for a sandbox

Request
header Parameters
Authorization
required
string

The bearer token for authorization.

x-gw-ims-org-id
required
string

The organization ID for Adobe Experience Platform.

x-api-key
required
string

The API key for Adobe Experience Platform.

x-sandbox-name
required
string

The name of the sandbox where the operation will take place.

Accept-Encoding
string
Default: identity

The type of response encoding expected. The supported values are gzip and identity.

Enum: "gzip" "identity"
Request Body schema: application/json
required
Array of objects

The list of IP ranges to allow for data access in the sandbox.

Responses
200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

put/security/ip-access
Request samples
application/json
{
  • "ipRanges": [
    ]
}
Response samples
application/json
{
  • "imsOrg": "18D63B2559DF0C130A49422D@AdobeOrg",
  • "sandboxName": "prod",
  • "channel": "data_distiller",
  • "allowedIpRanges": [
    ]
}

Delete all configured IP ranges for a sandbox

Request
header Parameters
Authorization
required
string

The bearer token for authorization.

x-gw-ims-org-id
required
string

The organization ID for Adobe Experience Platform.

x-api-key
required
string

The API key for Adobe Experience Platform.

x-sandbox-name
required
string

The name of the sandbox where the operation will take place.

Accept-Encoding
string
Default: identity

The type of response encoding expected. The supported values are gzip and identity.

Enum: "gzip" "identity"
Responses
200

Success

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/security/ip-access
Response samples
application/json
{
  • "imsOrg": "18D63B2559DF0C130A49422D@AdobeOrg",
  • "sandboxName": "prod",
  • "channel": "data_distiller",
  • "deletedIpRanges": [
    ]
}

IP Validation

Use the IP Validation endpoint to verify if a specified IP address is permitted to access data within a designated sandbox in Query Service.

Validate IP access for a sandbox

Request
header Parameters
Authorization
required
string

The bearer token for authorization.

Content-Type
required
string

The type of content being sent in the body of the request. The value should be 'application/json'.

x-gw-ims-org-id
required
string

The organization ID for Adobe Experience Platform.

x-api-key
required
string

The API key for Adobe Experience Platform.

x-sandbox-name
required
string

The name of the sandbox where the operation will take place.

Accept-Encoding
string
Default: identity

The type of response encoding expected. The supported values are gzip and identity.

Enum: "gzip" "identity"
Request Body schema: application/json
required
ipAddress
string

The IP address to be validated for sandbox access.

Responses
200

Success

401

Unauthorized

404

Not Found

500

Internal Server Error

post/security/validate/ip-access
Request samples
application/json
{
  • "ipAddress": "197.2.0.2"
}
Response samples
application/json
{
  • "isAllowed": true
}