Adobe

Adobe Experience Platform Flow Service API - Destinations

Use the Adobe Experience Platform Flow Service API to connect and activate data to various destinations within and outside of Adobe Experience Platform. This API reference is centered on exporting data to batch destinations like Amazon S3, SFTP, Azure Blob. >**NOTE**: Refer to [Flow Service API - So

GitHub OpenAPI

Operations 20

GET /connections Retrieve a list of destination base connections #
POST /connections Create a target base connection #
GET /connections/{id} Retrieve the details of a base connection #
PATCH /connections/{id} Update a base connection #
DELETE /connections/{id} Delete a base connection #
GET /sourceConnections Retrieve a list of source connections for destinations #
POST /sourceConnections Create a source connection #
GET /sourceConnections/{id} Retrieve the details of a source connection #
DELETE /sourceConnections/{id} Delete a source connection #
GET /targetConnections Retrieve a list of destination target connections #
POST /targetConnections Create a target connection #
GET /targetConnections/{id} Retrieve the details of a target connection #
DELETE /targetConnections/{id} Delete a target connection #
GET /flows Retrieve a list of destination dataflows #
POST /flows Create a destination dataflow #
GET /flows/{id} Retrieve a destination dataflow's details #
PATCH /flows/{id} Update a destination dataflow #
DELETE /flows/{id} Delete a destination dataflow #
GET /runs Retrieve a list of destination dataflow runs #
GET /connectionSpecs/{id}/configs Retrieve a list of datasets for activation #

Documentation

📖
Documentation
https://developer.adobe.com/experience-platform-apis/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/adobe/openapi/adobe-aep-destinations-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/AdobeDocs/experience-platform-apis/main/static/swagger-specs/destinations.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/adobe:adobe-aep-destinations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

adobe-aep-destinations-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  description: "Use the Adobe Experience Platform Flow Service API to connect and activate data to various destinations within and outside of\
    \ Adobe Experience Platform. This API reference is centered on exporting data to batch destinations like Amazon S3, SFTP, Azure Blob.\n>**NOTE**:\
    \ Refer to [Flow Service API - Sources](https://developer.adobe.com/experience-platform-apis/references/flow-service/) if you are looking\
    \ for API documentation to perform operations on *sources* in Experience Platform.\n- **Related documentation**:\n    - [Destinations overview](http://www.adobe.com/go/destinations-overview-en)\n\
    \    - [Activate data to file-based destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/activate-segments-file-based-destinations.html)\n\
    \    - [Activate data to streaming destinations - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/streaming-destinations.html)\n\
    \    - [Update destination dataflows - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/update-destination-dataflows.html)\n\
    \    - [Export datasets - API tutorial](https://experienceleague.adobe.com/docs/experience-platform/destinations/api/export-datasets.html)\n\
    \n- **API paths**:\n  - PLATFORM Gateway URL: https://<span>platform.adobe.io/\n  - Base path for this API: /data/foundation/flowservice\n\
    \  - Example of a complete path: https://<span>platform.adobe.io/data/foundation/flowservice/flows\n\n- **Required headers**:\n    - All service\
    \ calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the\
    \ [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).\n    - All resources in Experience Platform are isolated\
    \ to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of\
    \ the sandbox the operation will take place in (for example, \"prod\"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en)\
    \ for more information.\n    - All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header\
    \ `Content-Type` with a value of `application/json`.\n\n- **API error handling**:\n    - Refer to the Experience Platform API troubleshooting\
    \ guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#api-status-codes),\
    \ and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html#request-header-errors).\
    \ You can also view a list of [common Flow Service error messages](https://experienceleague.adobe.com/docs/experience-platform/sources/errors/flow-service-errors.html)\
    \ and resolution suggestions.\n\n\n- **Sorting and filtering responses**:\n    - When performing listing (GET) requests in the Flow Service\
    \ API, you can use query parameters to [sort and filter responses](https://experienceleague.adobe.com/docs/experience-platform/dataflows/api/sort-and-filter.html)."
  title: Flow Service API - Destinations
  version: 1.0.0
servers:
- url: https://{environment}.adobe.io/data/foundation/flowservice
  description: Adobe IO gateway endpoint
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: (NEW) Interactive API documentation
  description: You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your [authentication
    credentials](https://www.adobe.com/go/platform-api-get-credentials-en) 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.
- name: Glossary
  description: This section describes the terms that you will be encountering in this API documentation. For a complete reference of Experience
    Platform API terms, read the [Adobe Experience Platform glossary](https://experienceleague.adobe.com/docs/experience-platform/landing/glossary.html).
    <table><thead><tr><th>Term</th><th>Description</th></tr></thead> <tbody> <tr><td>Base connection</td><td>Base connections retain authentication
    information regarding how to connect to a target destination. You must set up a base connection before you can create a target connection.</td></tr>
    <tr><td>Source connection</td><td>Source connections create and manage a connection to the internal source from where data is exported. For
    destination connections, the source connection can be either the <a href="https://experienceleague.adobe.com/docs/experience-platform/landing/license/data-management-best-practices.html#understanding-adobe-experience-platform-data-storage">Experience
    Platform Profile Store</a> when exporting segments or <a href="https://experienceleague.adobe.com/docs/experience-platform/landing/license/data-management-best-practices.html#understanding-adobe-experience-platform-data-storage">Experience
    Platform Data Lake</a>, when [exporting datasets](https://experienceleague.adobe.com/docs/experience-platform/destinations/ui/activate/export-datasets.html).
    </td></tr> <tr><td>Target connection</td><td>Target connections create and manage a destination connection to any location where exported
    data will land. Target connections contain information regarding data destination, data format, and the target connection ID needed to create
    a destination dataflow.</td></tr> <tr><td>Dataflow</td><td>A dataflow is a virtual pipeline of data that flows into Platform from a source
    and out to a destination. This API reference focuses on destination dataflows.</td></tr> <tr><td>Dataflow run</td><td>A dataflow run is an
    execution instance of a dataflow that lands in Experience Platform based on a user-specified schedule OR that is exported from Experience
    Platform to a destination of your choice, also based on a user-specified schedule and other criteria. This API reference focuses on dataflow
    runs to destinations.</td></tr> </tbody></table>
- name: Base connections
  description: 'Base connections retain information regarding how to connect to a source or target.  For destinations, the source that you are
    connecting to is Experience Platform data and the target is the desired destination.  The base connection configuration always includes a
    unique `connectionSpec ID`, which is necessary in order to successfully access Experience Platform data and authorize a connection to the
    target destination.

    '
- name: Source connections
  description: Source connections create and manage a connection to the internal source from where data is exported. For destination connections,
    the source connection can be either the Experience Platform Profile Store or the Experience Platform Data Lake. Source connections contain
    information like data source, data format, and the source connection ID needed to create a dataflow. A source connection instance is specific
    to a tenant and organization.
- name: Target connections
  description: Target connections create and manage a destination connection to any location where exported data will land. Target connections
    contain information regarding data destination, data format, and the target connection ID needed to create a destination dataflow. A target
    connection instance is specific to a tenant and organization. <br><br> Before you create a target connection, you <i>must</i> create a base
    connection.
- name: Dataflows
  description: Destination dataflows represent the data transfer between a source connection (Experience Platform) and a target connection (the
    destination you set up). This also includes information regarding the data export schedule, and the transformation specifications of the data
    being exported to your destination. A dataflow instance is specific to a tenant and organization.
- name: Dataflow runs
  description: Dataflow runs represent an instance of a dataflow execution, which exports data to your destination. A dataflow run is specific
    to a dataflow and a segment for which the data export occurred. Furthermore, a run instance is specific to a tenant and organization.


# --- truncated at 32 KB (327 KB total) ---
# Full source: https://artifacts.apis.io/adobe/openapi/adobe-aep-destinations-openapi.yml