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-suite-target-connections-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Adobe Suite Target connections API
version: '1.0'
description: 'Operations tagged Target connections across 2 of this provider''s published API definitions: adobe-suite-aep-destinations-openapi.yaml, adobe-suite-aep-flow-service-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{environment}.adobe.io/data/foundation/flowservice
description: Adobe IO gateway endpoint
variables:
environment:
default: platform
enum:
- platform
- platform-stage
- url: //{environment}.adobe.io/data/foundation/flowservice
variables:
environment:
default: platform
enum:
- platform
- platform-stage
tags:
- 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.
paths:
/targetConnections:
get:
tags:
- Target connections
summary: Retrieve a list of destination target connections
description: 'You can retrieve a list of all destination target connections for your organization by making a GET request to the `/targetConnections` endpoint.
You can use query parameters to return only the target connections for a specific destination type. To do this, pass in the `connectionSpec.id` of the desired destination by using the `property` query parameter, as shown further below.
>**NOTE**: This operation allows you to retrieve a maximum of 100 entities. The most recently created or updated entities are returned first. Use filters to return the target connections that are most relevant to you.
'
operationId: getTargetConnections
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XApiKey'
- $ref: '#/components/parameters/XImsOrgId'
- $ref: '#/components/parameters/XSandboxId'
- $ref: '#/components/parameters/Accept'
- in: query
name: property
description: 'A comma-separated list of top-level object properties to be returned in the response. Used to cut down the amount of data returned in the response body. For example, `property=id==f2d1a98b-6b8c-420b-80a1-696c3f192eb2,b6730e09-7da6-40e2-b5cf-289545056dc3,49d17eff-9fa7-4e92-b84e-ab65fcb4730a`.
'
required: false
schema:
type: string
examples:
filterS3Connection:
summary: Filter connection for Amazon S3 destination
value: connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee
filterSftpConnection:
summary: Filter connection for SFTP destination
value: connectionSpec.id==36965a81-b1c6-401b-99f8-22508f1e6a26
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/orderby'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/continuationToken'
responses:
'200':
description: The specified target connection was successfully retrieved.
x-summary: Target Connection Details Retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TargetConnectionItem'
examples:
Amazon_S3_Target_Connection:
$ref: '#/components/examples/Amazon_S3_Target_Connection'
SFTP_Target_Connection:
$ref: '#/components/examples/SFTP_Target_Connection'
Amazon_S3_Target_Connection_Segment_V2:
$ref: '#/components/examples/Amazon_S3_Target_Connection_Segment_V2'
Amazon_S3_Target_Connection_Dataset_V2:
$ref: '#/components/examples/Amazon_S3_Target_Connection_Dataset_V2'
'401':
description: The token provided in the Authorization header is invalid.
x-summary: Invalid Authorization Token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error_code: 401013
message: Oauth token is not valid
'403':
description: You are not authorized to perform this operation
x-summary: Authorization Error - Access Denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The specified target connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
x-summary: Not Found - Target Connection ID Missing
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
errorMessage: targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]
errorDetails: targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]
'500':
description: An Internal error occurred.
x-summary: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- Target connections
summary: Create a target connection
description: 'Create a target connection to manage a destination connection to any location where exported data will land. In the request payload, specify information regarding the data destination and data format. The HTTP response returns the target connection ID, which you''ll later need to create a destination dataflow.
'
operationId: postTargetConnection
parameters:
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/Content-type'
- $ref: '#/components/parameters/XApiKey'
- $ref: '#/components/parameters/XImsOrgId'
- $ref: '#/components/parameters/XSandboxId'
- $ref: '#/components/parameters/Accept'
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/Create_S3_Target_Connection_Request'
- $ref: '#/components/schemas/Create_SFTP_Target_Connection_Request'
- $ref: '#/components/schemas/Create_S3_Target_Connection_Request_V2'
- $ref: '#/components/schemas/Create_SFTP_Target_Connection_Request_V2'
examples:
Create_SFTP_Target_Connection:
$ref: '#/components/examples/Create_SFTP_Target_Connection'
Create_S3_Target_Connection_Dataset:
$ref: '#/components/examples/Create_S3_Target_Connection_Dataset'
Create_S3_Target_Connection_Segment:
$ref: '#/components/examples/Create_S3_Target_Connection_Segment'
responses:
'201':
description: A new target connection was successfully created. The response contains the unique identifier (ID) and the etag value of the target connection.
x-summary: Target Connection Created Successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Create_Base_Connection_Response'
examples:
Create_Base_Connection_Response:
$ref: '#/components/examples/Create_Base_Connection_Response'
'401':
description: The token provided in the Authorization header is invalid.
x-summary: Invalid Authorization Token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error_code: 401013
message: Oauth token is not valid
'403':
description: You are not authorized to perform this operation
x-summary: Authorization Error - Access Denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'422':
description: connectionSpec.version 'version' is required for spec info. Make sure to include the version parameter alongside the connectionSpec. version is usually "1.0".
x-summary: Unprocessable Entity - Version Parameter Missing
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: An Internal error occurred.
x-summary: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://{environment}.adobe.io/data/foundation/flowservice
description: Adobe IO gateway endpoint
variables:
environment:
default: platform
enum:
- platform
- platform-stage
/targetConnections/{id}:
get:
tags:
- Target connections
summary: Retrieve the details of a target connection
description: 'You can retrieve detailed information about a specific target connection by making a GET request to the `/targetConnections` endpoint and providing the ID of the target connection you want to inspect.
'
operationId: getTargetConnectionById
parameters:
- name: id
in: path
description: The ID of the target connection you are looking to retrieve.
required: true
schema:
type: string
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XApiKey'
- $ref: '#/components/parameters/XImsOrgId'
- $ref: '#/components/parameters/XSandboxId'
- $ref: '#/components/parameters/Accept'
responses:
'200':
description: The specified target connection was successfully retrieved.
x-summary: Target Connection Details Retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TargetConnectionItem'
examples:
Amazon_S3_Target_Connection:
$ref: '#/components/examples/Amazon_S3_Target_Connection'
SFTP_Target_Connection:
$ref: '#/components/examples/SFTP_Target_Connection'
Amazon_S3_Target_Connection_Segment_V2:
$ref: '#/components/examples/Amazon_S3_Target_Connection_Segment_V2'
Amazon_S3_Target_Connection_Dataset_V2:
$ref: '#/components/examples/Amazon_S3_Target_Connection_Dataset_V2'
'401':
description: The token provided in the Authorization header is invalid.
x-summary: Invalid Authorization Token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error_code: 401013
message: Oauth token is not valid
'403':
description: You are not authorized to perform this operation
x-summary: Authorization Error - Access Denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The specified target connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
x-summary: Not Found - Target Connection ID Missing
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
errorMessage: targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]
errorDetails: targetConnections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]
'500':
description: An Internal error occurred.
x-summary: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- Target connections
summary: Delete a target connection
description: 'You can delete the specified source connection by making a DELETE request to the `/targetConnections` endpoint and providing the ID of the target connection that you wish to delete in the request path.
'
operationId: deleteTargetConnectionById
parameters:
- name: id
in: path
description: The ID of the target connection you are looking to delete.
required: true
schema:
type: string
- $ref: '#/components/parameters/Authorization'
- $ref: '#/components/parameters/XApiKey'
- $ref: '#/components/parameters/XImsOrgId'
- $ref: '#/components/parameters/XSandboxId'
- $ref: '#/components/parameters/Accept'
responses:
'202':
description: A successful response returns HTTP status 202 (No Content) and a blank body. You can confirm the deletion by attempting a lookup (GET) request to the target connection. The API will return an HTTP 404 (Not Found) error, indicating that the target connection has been deleted.
x-summary: Deletion Accepted - Target Connection Marked for Deletion
'401':
description: The token provided in the Authorization header is invalid.
x-summary: Invalid Authorization Token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error_code: 401013
message: Oauth token is not valid
'403':
description: You are not authorized to perform this operation
x-summary: Authorization Error - Access Denied
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: The specified target connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
x-summary: Not Found - Target Connection ID Missing
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
errorMessage: targetConnections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
errorDetails: targetConnections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
'500':
description: An Internal error occurred.
x-summary: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: https://{environment}.adobe.io/data/foundation/flowservice
description: Adobe IO gateway endpoint
variables:
environment:
default: platform
enum:
- platform
- platform-stage
/targetConnections/{TARGET_CONNECTION_ID}/action:
post:
tags:
- Target connections
summary: Performs a state transition action on an existing target connection.
description: Use this endpoint to perform a state transition action on an existing target connection.
operationId: performAction_2
parameters:
- name: Authorization
in: header
description: The access token which can be copied from your Experience Platform integration, prefixed with 'Bearer '. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-sandbox-name
in: header
description: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
schema:
type: string
- name: TARGET_CONNECTION_ID
in: path
description: The ID of the queried target connection.
required: true
schema:
type: string
- name: op
in: query
description: The operative action to perform against the queried target connection.
required: true
schema:
type: string
enum:
- PUBLISH
responses:
'200':
x-summary: Success
description: Successful operation. A successful response returns the target connection with an updated state.
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTargetConnectionResponse'
'401':
description: The user is unauthorized. Contact your administrator to resolve permissions and access the resource.
'500':
description: An internal error has occurred. Please try again. If the problem persisits, contact customer support.
servers:
- url: //{environment}.adobe.io/data/foundation/flowservice
variables:
environment:
default: platform
enum:
- platform
- platform-stage
/targetConnections/{TARGET_CONNECTION_ID}:
get:
tags:
- Target connections
summary: Retrieve a target connection
description: Retrieve a single target connection by making a GET request to the `/targetConnections/{TARGET_CONNECTION_ID}` endpoint while providing the ID of the target connection you want to retrieve.
operationId: retrieveTargetConnection
parameters:
- name: Authorization
in: header
description: The access token which can be copied from your Experience Platform integration, prefixed with 'Bearer '. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: TARGET_CONNECTION_ID
in: path
description: The ID of the target connection you want to retrieve.
required: true
schema:
type: string
responses:
'200':
description: Successful operation. A successful response returns details of specified target connection in JSON format.
x-summary: Target Connection Details Retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TargetConnectionsListResponse'
'403':
description: The OAuth token is missing.
x-summary: Authorization Error - Missing OAuth Token
content: {}
'503':
description: The service is unavailable.
x-summary: Server Error - Service Unavailable
content: {}
delete:
tags:
- Target connections
summary: Delete a target connection
description: Use this endpoint to delete an instance of a target connection.
operationId: deleteTargetConnection
parameters:
- name: Authorization
in: header
description: The access token which can be copied from your Experience Platform integration, prefixed with 'Bearer '. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-sandbox-name
in: header
description: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
schema:
type: string
- name: TARGET_CONNECTION_ID
in: path
description: The ID of the target connection you want to delete.
required: true
schema:
type: string
responses:
'204':
description: The target connection was successfully deleted (No content).
x-summary: Target Connection Deleted
content: {}
'403':
description: The OAuth token is missing.
x-summary: Authorization Error - Missing OAuth Token
content: {}
'503':
description: The service is unavailable.
x-summary: Server Error - Service Unavailable
content: {}
patch:
tags:
- Target connections
summary: Update a target connection
description: Use this endpoint to update a target connection.
operationId: patchTargetConnection
parameters:
- name: Authorization
in: header
description: The access token which can be copied from your Experience Platform integration, prefixed with 'Bearer '. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-api-key
in: header
description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-gw-ims-org-id
in: header
description: The organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
required: true
schema:
type: string
- name: x-sandbox-name
in: header
description: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
schema:
type: string
- name: if-match
in: header
description: A parameter required when updating a connection or a dataflow. When making a PUT or PATCH request, you must add an `if-match` header parameter and include the current version/etag of the resource that you want to update to complete the update.
required: true
schema:
type: string
- name: TARGET_CONNECTION_ID
in: path
description: The ID of the target connection you want to update.
required: true
schema:
type: string
requestBody:
description: '- **op** - **(Required)** The operation call used to define the action needed to update the connection. Operations include `add`, `replace`, and `remove`.
- **path** - (Optional) The path of the parameter to be updated.
- **value** - **(Required)** The new value you want to update your parameter with.'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PatchInstruction'
required: true
responses:
'200':
description: Successful operation. A successful response returns details of specified target connection in JSON format.
x-summary: Target Connection Details Retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TargetConnectionsListResponse'
'403':
description: The OAuth token is missing.
x-summary: Authorization Error - Missing OAuth Token
content: {}
'503':
description: The service is unavailable.
x-summary: Server Error - Service Unavailable
content: {}
x-codegen-request-body-name: body
servers:
- url: //{environment}.adobe.io/data/foundation/flowservice
variables:
environment:
default: platform
enum:
- platform
- platform-stage
components:
parameters:
XApiKey:
in: header
name: x-api-key
description: The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
schema:
type: string
required: true
orderby:
in: query
name: orderby
description: Sort response by specified fields separated by `,` and/or prefix field with `-` for descending order.
required: false
schema:
type: string
Accept:
in: header
name: Accept
description: An optional content negotiation header which allows you to use a specific version of the API. If you don't use it, the HTTP responses fall back to the latest version of the API.
schema:
type: string
default: application/json; version=1
required: false
continuationToken:
in: query
name: continuationToken
description: A token for fetching records for next page. This is a system-generated token.
required: false
schema:
type: string
count:
in: query
name: count
description: A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`).
required: false
schema:
type: boolean
Content-type:
in: header
name: Content-type
description: The type of content being sent in the body of the request. Should be 'application/json'.
schema:
type: string
default: application/json
required: true
XSandboxId:
in: header
name: x-sandbox-name
description: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place.
schema:
type: string
required: true
Authorization:
in: header
name: Authorization
description: The access token which can be copied from your Experience Platform integration, prefixed with 'Bearer '. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
schema:
type: string
required: true
limit:
in: query
name: limit
description: Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`.
required: false
schema:
type: integer
maximum: 100
XImsOrgId:
in: header
name: x-gw-ims-org-id
description: The organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
schema:
type: string
required: true
schemas:
SFTPTargetConnectionRequest_V2:
type: object
title: (Beta) Amazon Target Connection Request
description: 'The parameters in the target connection payload which are required to export data to an Amazon S3 instance.
'
required:
- params
- connectionSpec
properties:
params:
$ref: '#/components/schemas/SFTPTargetConnectionParams_V2'
connectionSpec:
type: object
title: Connection Spec.
description: Request model for connection spec information.
required:
- id
- version
properties:
id:
type: string
title: Id
description: Connection spec ID. Each destination connector has a unique connection spec ID, which must be used when establishing base, source, or target connections for that specific destination.
enum:
- 36965a81-b1c6-401b-99f8-22508f1e6a26
version:
type: string
title: Version
description: Connection spec version. This value is `1.0` unless clearly specified otherwise.
AmazonS3TargetConnectionRequest_V2:
type: object
title: (Beta) Amazon Target Connection Request
description: 'The parameters in the target connection payload which are required to export data to an Amazon S3 instance.
'
required:
- params
- connectionSpec
properties:
params:
$ref: '#/components/schemas/AmazonS3TargetConnectionParams_V2'
connectionSpec:
type: object
title: Connection Spec.
description: Request model for connection spec information.
required:
- id
- version
properties:
id:
type: string
title: Id
description: Connection spec ID. Each destination connector has a unique connection spec ID, which must be used when establishing base, source, or target connections for that specific destination.
enum:
- 4fce964d-3f37-408f-9778-e597338a21ee
version:
type: string
title: Version
description: Connection spec version. This value is `1.0` unless clearly specified otherwise.
BaseSFTPTargetConnectionParams_V2:
type: object
title: (Beta) SFTP Base Target Connection Parameters
required:
- remotePath
properties:
remotePath:
type: string
title: Folder Path
description: The path to the folder location in your SFTP server where the exported files will be deposited.
Create_S3_Target_Connection_Request_V2:
type: object
title: (Beta) Amazon S3 Target Connection Request
description: 'API request to create a target connection to an Amazon S3 instance, specifying data export format
# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-target-connections-api-openapi.yml