openapi: 3.2.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 Base connections API
  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: 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.

    '
paths:
  /connections:
    get:
      tags:
      - Base connections
      summary: Retrieve a list of destination base connections
      description: "You can retrieve a list of all destination base connections for your organization by making a GET request to the `/connections` endpoint.\n\nYou can use query parameters to return only the base 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.\n        \n>**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 base connections that are most relevant to you.\n"
      operationId: getConnections
      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 to return connections for Amazon S3 destinations only.
            value: connectionSpec.id==4fce964d-3f37-408f-9778-e597338a21ee
          filterSftpConnection:
            summary: Filter to return connections for SFTP destinations only.
            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: Successful operation. A successful response returns a list of base connections that match the request parameters.
          x-summary: List of Base Connections Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionItem'
              examples:
                Connections:
                  $ref: '#/components/examples/ConnectionsResponse'
        '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'
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - Base connections
      summary: Create a target base connection
      description: 'A target base connection authorizes the connection to your desired destination type. The required authorization parameters vary based on the destination that you are looking to connect to.

        '
      operationId: postTargetBaseConnection
      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_Base_Connection_Request'
              - $ref: '#/components/schemas/Create_SFTP_Base_Connection_Request'
              - $ref: '#/components/schemas/Create_S3_Base_Connection_Request_V2'
              - $ref: '#/components/schemas/Create_SFTP_Base_Connection_Request_V2'
            examples:
              Create_S3_Base_Connection:
                $ref: '#/components/examples/Create_S3_Base_Connection'
              Create_SFTP_With_Password_Connection:
                $ref: '#/components/examples/Create_SFTP_With_Password_Base_Connection'
              Create_SFTP_With_SSH_Key_Connection:
                $ref: '#/components/examples/Create_SFTP_With_SSH_Key_Base_Connection'
      responses:
        '201':
          description: A new base connection was successfully created. The response contains the unique identifier (ID) and the etag value of the base connection.
          x-summary: Base 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'
        '400':
          description: Bad request. A valid connection spec ID is required.
          x-summary: Bad Request - Invalid Connection Spec ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                message: Please provide a valid spec id
        '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 - Missing Required Version Parameter
          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'
  /connections/{id}:
    get:
      tags:
      - Base connections
      summary: Retrieve the details of a base connection
      description: 'You can retrieve detailed information about a specific base connection by making a GET request to the `/connections` endpoint and providing the ID of the connection you want to inspect.

        '
      operationId: getConnectionById
      parameters:
      - name: id
        in: path
        description: The ID of the 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 base connection was successfully retrieved.
          x-summary: Base Connection Details Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionItem'
              examples:
                Amazon_S3_Connection:
                  $ref: '#/components/examples/Amazon_S3_Connection'
                SFTP_Connection:
                  $ref: '#/components/examples/SFTP_Connection'
                Amazon_S3_Connection_V2:
                  $ref: '#/components/examples/Amazon_S3_Connection_V2'
                SFTP_Connection_V2:
                  $ref: '#/components/examples/SFTP_Connection_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 base connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
          x-summary: Not Found - Base Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: connections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]
                errorDetails: connections not found with id = [4890fc95-5a1f-4983-94bb-e060c08e3f]
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema: null
          $ref: '#/components/schemas/ErrorResponse'
    patch:
      tags:
      - Base connections
      summary: Update a base connection
      description: 'You can update a base connection by making a PATCH request to the `/connections` endpoint and providing the ID of the base connection you want to update. In the body of the request, provide the updated configuration of the connection.

        '
      operationId: patchConnectionById
      parameters:
      - name: id
        in: path
        description: The ID of the connection you are looking to update.
        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'
      - $ref: '#/components/parameters/Content-type'
      - $ref: '#/components/parameters/if-match'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchConnectionItem'
            examples:
              Patch_Connection_Remove_Auth_Params:
                $ref: '#/components/examples/Patch_Connection_Remove_Auth_Params'
              Patch_Connection_Add_S3_Auth_Params:
                $ref: '#/components/examples/Patch_Connection_Add_S3_Auth_Params'
              Patch_Connection_Replace_Auth_Params:
                $ref: '#/components/examples/Patch_Connection_Replace_Auth_Params'
      responses:
        '200':
          description: Details of your newly updated base connection are returned.
          x-summary: Base Connection Updated Successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Patch_Connection_Response'
              examples:
                Patch_Connection_Response:
                  $ref: '#/components/examples/Patch_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'
        '404':
          description: The specified base connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
          x-summary: Not Found - Base Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: connections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
                errorDetails: connections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
        '412':
          description: 'Pre-condition failed error. This can occur if the supplied eTag does not match the latest eTag for the resource or if the supplied eTag is not correctly wrapped in double quotes. To resolve this, you need to fetch the entity again, make sure that your changes are compatible with new version of the entity, then place the new eTag in the If-Match header, and finally make the API call, while ensuring the eTag is wrapped in double quotes "".

            '
          x-summary: Precondition Failed - ETag Mismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: Supplied version=["04001277-0000-0200-0000-62d9b13e00001"] does not match the current version on entity=["0400117f-0000-0200-0000-62d9bca50000"]
                errorDetails: Supplied version=["04001277-0000-0200-0000-62d9b13e00001"] does not match the current version on entity=["0400117f-0000-0200-0000-62d9bca50000"]
        '500':
          description: An Internal error occurred.
          x-summary: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - Base connections
      summary: Delete a base connection
      description: 'You can delete the specified base connection by making a DELETE request to the `/connections` endpoint and providing the ID of the connection that you wish to delete in the request path.

        '
      operationId: deleteConnectionById
      parameters:
      - name: id
        in: path
        description: The ID of the 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 connection. The API will return an HTTP 404 (Not Found) error, indicating that the connection has been deleted.
          x-summary: Deletion Request Accepted
        '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 base connection ID was not found. The resource may have been deleted, or the requested path was entered incorrectly.
          x-summary: Not Found - Base Connection ID Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                errorMessage: connections not found with id = [ca5c6e9a-8559-4a08-97a5-f15b756da600-]
                errorDetails: connections 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'
components:
  examples:
    SFTP_Connection_V2:
      summary: (Beta) SFTP connection Example.
      value:
        items:
        - id: 63e0b47b-94bd-4b20-a395-81ff6b496335
          createdAt: 1654785125699
          updatedAt: 1654791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: (Beta) SFTP Connection
          connectionSpec:
            id: 36965a81-b1c6-401b-99f8-22508f1e6a26
            version: '1.0'
          state: enabled
          auth:
            specName: SFTP with Password
            params:
              authorizedDate: '2022-08-03'
              username: testUser
              password: testPassword
              domain: ftp.test.com
          version: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"'
          etag: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"'
    Create_Base_Connection_Response:
      summary: Base Connection Response
      value:
        id: 77eeb629-f08a-48e2-8c7b-e345e246ff45
        etag: '"ac00c7db-0000-0200-0000-62eabd5c0000"'
    Amazon_S3_Connection:
      summary: Amazon S3 connection Example.
      value:
        items:
        - id: 9d8159c6-9da6-4205-8507-d818d7ad7103
          createdAt: 1654785125699
          updatedAt: 1654791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: amazon-s3
          connectionSpec:
            id: 4890fc95-5a1f-4983-94bb-e060c08e3f81
            version: '1.0'
          auth:
            specName: Access Key
            params:
              authorizedDate: '2022-08-03'
              s3SecretKey: '{SECRET_KEY}'
              s3AccessKey: '{ACCESS_KEY}'
          state: enabled
          version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
          etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
    SFTP_Connection:
      summary: SFTP connection Example.
      value:
        items:
        - id: e6f3a300-0bf7-4755-b7f8-308dc2a99133
          createdAt: 1654785125699
          updatedAt: 1654791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: amazon-s3
          connectionSpec:
            id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0
            version: '1.0'
          state: enabled
          auth:
            specName: Basic Authentication for sftp
            params:
              authorizedDate: '2022-08-03'
              password: testPassword
              userName: testUser
              host: ftp.test.com
          version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
          etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
    Amazon_S3_Connection_V2:
      summary: (Beta) Amazon S3 connection Example.
      value:
        items:
        - id: 340d288f-c020-435d-a41f-094520fa83eb
          createdAt: 1654785125699
          updatedAt: 1654791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: (Beta) Amazon S3
          connectionSpec:
            id: 4fce964d-3f37-408f-9778-e597338a21ee
            version: '1.0'
          auth:
            specName: Access Key
            params:
              authorizedDate: '2022-11-03'
              s3SecretKey: '{SECRET_KEY}'
              s3AccessKey: '{ACCESS_KEY}'
          state: enabled
          version: '"26013a41-0000-0200-0000-6361687a0000"'
          etag: '"26013a41-0000-0200-0000-6361687a0000"'
    Patch_Connection_Replace_Auth_Params:
      summary: Add authentication parameters to your Amazon S3 connection. Once you add new params, this will override all prior auth params.
      value:
      - op: replace
        path: /auth/params
        value:
          accessId: replaceAccessId
          secretKey: replaceSecretKey
    Patch_Connection_Remove_Auth_Params:
      summary: Remove Auth params to your connection
      value:
      - op: remove
        path: /auth/params
        value:
          accessId: exampleAccessId
          secretKey: exampleSecretKey
    ConnectionsResponse:
      summary: Connections response example.
      value:
        items:
        - id: 9d8159c6-9da6-4205-8507-d818d7ad7103
          createdAt: 1654785125699
          updatedAt: 1654791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: amazon-s3
          connectionSpec:
            id: 4890fc95-5a1f-4983-94bb-e060c08e3f81
            version: '1.0'
          auth:
            specName: Access Key
            params:
              authorizedDate: '2022-08-03'
              s3SecretKey: '{SECRET_KEY}'
              s3AccessKey: '{ACCESS_KEY}'
          state: enabled
          version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
          etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
        - id: e6f3a300-0bf7-4755-b7f8-308dc2a99133
          createdAt: 1654785125699
          updatedAt: 1654791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: amazon-s3
          connectionSpec:
            id: 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0
            version: '1.0'
          state: enabled
          auth:
            specName: Basic Authentication for sftp
            params:
              authorizedDate: '2022-08-03'
              password: testPassword
              userName: testUser
              host: ftp.test.com
          version: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
          etag: '"0e0d95ae-0000-0200-0000-62a21cdd0000"'
        - id: 340d288f-c020-435d-a41f-094520fa83eb
          createdAt: 1634785125699
          updatedAt: 1644791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: (Beta) Amazon S3 Connection
          connectionSpec:
            id: 4fce964d-3f37-408f-9778-e597338a21ee
            version: '1.0'
          auth:
            specName: Access Key
            params:
              authorizedDate: '2022-11-03'
              s3SecretKey: '{SECRET_KEY}'
              s3AccessKey: '{ACCESS_KEY}'
          state: enabled
          version: '"26013a41-0000-0200-0000-6361687a0000"'
          etag: '"26013a41-0000-0200-0000-6361687a0000"'
        - id: 63e0b47b-94bd-4b20-a395-81ff6b496335
          createdAt: 1674785125699
          updatedAt: 1684791389756
          createdBy: example@AdobeID
          updatedBy: example@AdobeID
          createdClient: example_client
          updatedClient: example_updated client
          sandboxId: '{SANDBOX_ID}'
          sandboxName: '{SANDBOX_NAME}'
          imsOrgId: destinationapi@AdobeOrg
          name: (Beta) SFTP Connection
          connectionSpec:
            id: 36965a81-b1c6-401b-99f8-22508f1e6a26
            version: '1.0'
          state: enabled
          auth:
            specName: SFTP with Password
            params:
              authorizedDate: '2022-08-03'
              username: testUser
              password: testPassword
              domain: ftp.test.com
          version: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"'
          etag: '"56fda0d4-3858-4657-b679-adf65b9ddf9b"'
    Create_SFTP_With_Password_Base_Connection:
      summary: Authorize the connection to an SFTP instance with password authentication
      value:
        name: SFTP with Password Base Connection
        auth:
          specName: Basic Authentication for sftp
          params:
            domain: '{DOMAIN}'
            host: '{HOST}'
            username: '{USERNAME}'
            password: '{PASSWORD}'
        connectionSpec:
          id: 36965a81-b1c6-401b-99f8-22508f1e6a26
          version: '1.0'
    Create_S3_Base_Connection:
      summary: Authorize the connection to an Amazon S3 instance with access key authentication
      value:
        name: Amazon S3 Base Connection
        auth:
          specName: Access Key
          params:
            s3SecretKey: <Add secret key>
            s3AccessKey: <Add access key>
        connectionSpec:
          id: 4fce964d-3f37-408f-9778-e597338a21ee
          version: '1.0'
    Patch_Connection_Add_S3_Auth_Params:
      summary: Add authentication parameters to your Amazon S3 connection. Once you add new params, this will override all prior auth params.
      value:
      - op: add
        path: /auth/params
        value:
          accessId: exampleAccessId
          secretKey: exampleSecretKey
    Create_SFTP_With_SSH_Key_Base_Connection:
      summary: Authorize the connection to an SFTP instance with SSH Key authentication
      value:
        name: SFTP with SSH Key Base Connection
        auth:
          specName: SSH PublicKey Authentication for sftp
          params:
            domain: '{DOMAIN}'
            host: '{HOST}'
            username: '{USERNAME}'
            sshKey: '{SSH_KEY}'
            port: 22
        connectionSpec:
          id: 36965a81-b1c6-401b-99f8-22508f1e6a26
          version: '1.0'
  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
    if-match:
      in: header
      name: if-match
      description: A header containing the eTag value of the entity to be updated (destination dataflow, base or target connection, etc.). Perform a GET request to return the latest eTag version of the entity. Note that you always need to wrap this header in double quotes when using it.
      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:
    ConnectionS3DestinationAuthValues:
      type: object
      title: Authentication parameters for Amazon S3 base connections
      description: 'Contains the fields that are required to authorize the connection to an Amazon S3 instance.

        '
      properties:
        value:
          type: object
          title: Connection Value Object
          description: "Contains the fields that are required to authorize the connection to an Amazon S3 instance. \n"
          properties:
            accessId:
              type: string
              title: Access ID
              description: Specify the Access ID for your S3 Authentication.
            secretKey:
              type: string
              title: S3 Secret Key
              description: Specify the S3 server secret key for your S3 server authentication.
    SFTPWithSSHKeyBaseConnectionAuthParameters_V2:
      type: object
      title: (Beta) Authentication Parameters for SFTP with SSH Key authorization
      description: 'The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH key authorization.

        '
      properties:
        specName:
          type: string
          title: Spec Name
          description: "The supported authentication scheme for connecting to an SFTP instance with SSH Key authorization. \n"
          enum:
          - SFTP with SSH Key
        params:
          type: object
          description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH Key authorization.
          required:
          - domain
          - username
          - sshKey
          properties:
            domain:
              type: string
              title: Domain
              description: The IP address or the domain name of your SFTP account.
              example: yourcompany.sftplocation.com
            username:
              type: string
              title: Username
              description: The username used to access the SFTP location.
            sshKey:
              type: string
              title: SSH Key
              description: The SSH Key used to access the SFTP location.
    Patch_Connection_Response:
      type: object
      title: Patch Connection Response
      description: API response for a successful PATCH operation.
      properties:
        id:
          type: string
          title: Connection ID
          description: The connection ID for which the API request was made.
        etag:
          type: string
          title: E-Tag
          description: An updated etag for the connection ID.
    Create_SFTP_Base_Connection_Request:
      type: object
      title: SFTP Base Connection Request
      description: 'API request to authorize the connection to an SFTP instance that uses password or SSH Key authorization.

        '
      allOf:
      - $ref: '#/components/schemas/GenericBaseConnectionRequest'
      - $ref: '#/components/schemas/SFTPBaseConnectionRequest'
    Create_Base_Connection_Response:
      title: Create Base Connection Response
      description: API response for a successful create base connection operation.
      allOf:
      - $ref: '#/components/schemas/GenericEntityCreationResponse'
    SFTPWithPasswordBaseConnectionAuthParameters_V2:
      type: object
      title: (Beta) Authentication Parameters for SFTP with password authorization
      description: 'The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization.

        '
      properties:
        specName:
          type: string
          title: Spec Name
          description: "The supported authentication scheme for connecting to an SFTP instance with password authorization. \n"
          enum:
          - SFTP with Password
        params:
          type: object
          description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization.
          required:
          - domain
          - username
          - password
          properties:
            domain:
              type: string
              title: Domain
              description: The IP address or the domain name of your SFTP account.
              example: yourcompany.sftplocation.com
            username:
              type: string
              title: Username
              description: The username used to access the SFTP location.
            password:
              type: string
              title: Password
              description: The password used to access the SFTP location.
    SFTPBaseConnectionRequest_V2:
      type: object
      title: SFTP authorization parameters
      description: 'The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password or SSH key authorization.

        '
      required:
      - auth
      - connectionSpec
      properties:
        auth:
          description: Authentication parameters to authorize the connection to an SFTP instance.
          oneOf:
          - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters_V2'
          - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters_V2'
        connectionSpec:
          type: object
          title: (Beta) 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.
    ErrorResponse:
      type: object
    SFTPWithPasswordBaseConnectionAuthParameters:
      type: object
      title: Authentication Parameters for SFTP with password authorization
      description: The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization.
      properties:
        specName:
          type: string
          title: Spec Name
          description: "The supported authentication scheme for connecting to an SFTP instance with password authorization. \n"
          enum:
          - Basic Authentication for sftp
        params:
          type: object
          description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password authorization.
          required:
          - domain
          - host
          - username
          - password
          properties:
            domain:
              type: string
              title: Domain
              description: The IP address or the domain name of your SFTP account.
            host:
              type: string
              title: Host
              description: The address of your SFTP storage location.
            username:
              type: string
              title: Username
              description: The username used to access the SFTP location.
            password:
              type: string
              title: Password
              description: The password used to access the SFTP location.
    Create_S3_Base_Connection_Request:
      type: object
      title: Amazon S3 Base Connection Request
      description: 'API request to authorize the connection to an Amazon S3 instance.

        '
      allOf:
      - $ref: '#/components/schemas/GenericBaseConnectionRequest'
      - $ref: '#/components/schemas/AmazonS3SecretAndAccessKeyBaseConnectionRequest'
    SFTPBaseConnectionRequest:
      type: object
      title: SFTP authorization parameters
      description: 'The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses password or SSH key authorization.

        '
      required:
      - auth
      - connectionSpec
      properties:
        auth:
          description: Authentication parameters to authorize the connection to an SFTP instance.
          oneOf:
          - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters'
          - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters'
        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:
              - 64ef4b8b-a6e0-41b5-9677-3805d1ee5dd0
            version:
              type: string
              title: Version
              description: Connection spec version. This value is `1.0` unless clearly specified otherwise.
    PatchConnectionItem:
      type: object
      title: Patch Command
      description: A json patch command as per the RFC - https://datatracker.ietf.org/doc/html/rfc6902
      required:
      - op
      - path
      - value
      properties:
        op:
          type: string
          title: PATCH operation
          description: The operation that you are performing on the connection. You can add, replace, or remove items from connections.
          enum:
          - add
          - replace
          - remove
        path:
          type: string
          title: Path
          description: A json xpath where the value has to be added, updated, or removed.
        value:
          description: Select the relevant schema to update authentication parameters for your destination.
          oneOf:
          - $ref: '#/components/schemas/ConnectionS3DestinationAuthValues'
          - $ref: '#/components/schemas/ConnectionSFTPWithSSHKeyDestinationAuthValues'
          - $ref: '#/components/schemas/ConnectionSFTPWithPasswordDestinationAuthValues'
    AmazonS3Auth:
      type: object
      title: Authentication Parameters
      description: Request model to capture authentication details for Amazon S3 connections.
      properties:
        specName:
          type: string
          title: Spec Name
          description: 'Supported authentication scheme for connecting to Amazon S3.  Currently, only a single type of key based scheme (access key authentication) is supported.

            '
          enum:
          - Access Key
        params:
          type: object
          description: Required and optional parameters to authorize a connection to an Amazon S3 instance.
          required:
          - s3SecretKey
          - s3AccessKey
          properties:
            s3SecretKey:
              type: string
              title: Secret Key.
              description: The secret key that grants access to your Amazon S3 instance.
              pattern: ^[A-Za-z0-9\/\+]{40}$
            s3AccessKey:
              type: string
              title: Access Key.
              description: The access key that grants access to your Amazon S3 instance.
              pattern: ^[A-Z2-7]{20}$
    ConnectionSFTPWithPasswordDestinationAuthValues:
      type: object
      title: Authentication parameters for SFTP With Password base connections
      description: 'Contains the fields that are required to authorize the connection to an SFTP instance, by using password authentication.

        '
      properties:
        value:
          type: object
          title: Connection Value Object
          description: "Contains the fields that are required to authorize the connection to an SFTP instance, by using password authentication. \n"
          properties:
            host:
              type: string
              title: Host
              description: Specify the host for your SFTP server authentication.
            username:
              type: string
              title: Username
              description: Specify the username for your SFTP server authentication.
            password:
              type: string
              title: Password.
              description: Specify the password for your SFTP server authentication.
    SFTPWithSSHKeyBaseConnectionAuthParameters:
      type: object
      title: Authentication Parameters for SFTP with SSH Key authorization
      description: The parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH key authorization.
      properties:
        specName:
          type: string
          title: Spec Name
          description: "The supported authentication scheme for connecting to an SFTP instance with SSH Key authorization. \n"
          enum:
          - SFTP with SSH Key
        params:
          type: object
          description: The authentication parameters in the base connection payload which are required to authorize a connection to an SFTP instance that uses SSH Key authorization.
          required:
          - domain
          - host
          - username
          - sshKey
          - port
          properties:
            domain:
              type: string
              title: Domain
              description: The IP address or the domain name of your SFTP account.
            host:
              type: string
              title: Host
              description: The address of your SFTP storage location.
            username:
              type: string
              title: Username
              description: The username used to access the SFTP location.
            sshKey:
              type: string
              title: SSH Key
              description: The SSH Key used to access the SFTP location.
            port:
              type: integer
              title: Port
              description: The port used to access the SFTP location.
    AmazonS3SecretAndAccessKeyBaseConnectionRequest:
      type: object
      title: Amazon S3 authorization parameters.
      description: 'The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance.

        '
      required:
      - auth
      - connectionSpec
      properties:
        auth:
          $ref: '#/components/schemas/AmazonS3AuthParameters'
        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:
              - 4890fc95-5a1f-4983-94bb-e060c08e3f81
            version:
              type: string
              title: Version
              description: Connection spec version. This value is `1.0` unless clearly specified otherwise.
    AmazonS3AuthParameters:
      type: object
      title: Authentication Parameters
      description: 'The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance.

        '
      properties:
        specName:
          type: string
          title: Spec Name
          description: 'Support authentication scheme for connecting to Amazon S3.  Currently only a single type of key-based scheme is supported.

            '
          enum:
          - Access Key
        params:
          type: object
          description: Authentication parameters for an Amazon S3 instance.
          required:
          - s3SecretKey
          - s3AccessKey
          properties:
            s3SecretKey:
              type: string
              title: Secret Key.
              description: The secret key that grants access to your Amazon S3 instance.
              pattern: ^[A-Za-z0-9\/\+]{40}$
            s3AccessKey:
              type: string
              title: Access Key.
              description: The access key that grants access to your Amazon S3 instance.
              pattern: ^[A-Z2-7]{20}$
    GenericEntityCreationResponse:
      type: object
      title: Flow Creation Response
      description: API response for a successful create operation.
      properties:
        id:
          type: string
          title: Flow ID
          description: The dataflow ID for which the API request was made.
        etag:
          type: string
          title: E-Tag
          description: An updated etag for the dataflow ID.
    ConnectionItem:
      type: object
      title: Connection Items
      description: Parameters specific to connections.
      required:
      - id
      - createdAt
      - updatedAt
      - createdBy
      - updatedBy
      - createdClient
      - updatedClient
      - sandboxId
      - imsOrgId
      - name
      - connectionSpec
      - state
      - auth
      - version
      - etag
      properties:
        id:
          type: string
          title: Connection ID
          description: The ID of the base connection.
        createdAt:
          type: integer
          title: Connection creation time
          description: The epoch time in milliseconds when the base connection was created.
        updatedAt:
          type: integer
          title: Connection update time
          description: The epoch time in milliseconds when the base connection was last updated.
        createdBy:
          type: string
          title: Created User
          description: The Adobe ID of the Identity Management System (IMS) user who created the base connection. In the case of service tokens, the value for `createdBy` is the same as `createdClient`.
        updatedBy:
          type: string
          title: Updated User
          description: The Adobe ID of the Identity Management System (IMS) user who last updated the base connection. In the case of service tokens, the value for `createdBy` is the same as `createdClient`.
        createdClient:
          type: string
          title: Created client
          description: The Adobe Identity Management System (IMS) client who created the base connection. This can be an application or a user. For example, the value `exc_app` represents base connections created in the Experience Platform UI.
        updatedClient:
          type: string
          title: Updated client
          description: The Adobe Identity Management System (IMS) client who last updated the base connection. This can be an application or a user. For example, the value `exc_app` represents base connections created in the Experience Platform UI.
        imsOrgId:
          type: string
          title: IMS org ID
          description: The organization ID to which the base connection belongs.
        sandboxId:
          type: string
          title: Sandbox ID
          description: The ID of the sandbox in which the base connection was created.
        sandboxName:
          type: string
          title: Sandbox Name
          description: The name of the sandbox in which the base connection was created.
        name:
          type: string
          title: Connection name
          description: The name of the base connection.
        etag:
          type: string
          title: eTag
          description: The updated, unique eTag returned by the HTTP response. The eTag value updates with every successful update of a base connection.
        state:
          type: string
          title: Connection state
          description: 'Represents the current state of the base connection. A base connection can be `enabled` or `disabled`.

            '
          enum:
          - enabled
          - disabled
        connectionSpec:
          type: object
          title: Connection Spec.
          description: Request model for connection spec information.
          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.
            version:
              type: string
              title: Version
              description: Connection spec version. This value is `1.0` unless clearly specified otherwise.
        auth:
          description: Authentication parameters specific to the destination type.
          oneOf:
          - $ref: '#/components/schemas/AmazonS3Auth'
          - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters'
          - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters'
          - $ref: '#/components/schemas/SFTPWithPasswordBaseConnectionAuthParameters_V2'
          - $ref: '#/components/schemas/SFTPWithSSHKeyBaseConnectionAuthParameters_V2'
    ConnectionSFTPWithSSHKeyDestinationAuthValues:
      type: object
      title: Authentication parameters for SFTP With SSH Key base connections
      description: 'Contains the fields that are required to authorize the connection to an SFTP instance, by using SSH key authentication.

        '
      properties:
        value:
          type: object
          title: Connection Value Object
          description: "Contains the fields that are required to authorize the connection to an SFTP instance, by using SSH key authentication. \n"
          properties:
            domain:
              type: string
              title: Domain
              description: Specify the domain for your SFTP server authentication.
            username:
              type: string
              title: Username
              description: Specify the username for your SFTP server authentication.
            sshKey:
              type: string
              title: SSH Key
              description: Specify the SSH Key for your SFTP server authentication.
    GenericBaseConnectionRequest:
      type: object
      title: Base Connection Request
      description: 'A base model that outlines the common request properties across all base connection requests.

        '
      required:
      - name
      properties:
        name:
          type: string
          title: Name
          description: The name of the base connection.
        description:
          type: string
          title: Description
          description: An optional description for the base connection.
    AmazonS3SecretAndAccessKeyBaseConnectionRequest_V2:
      type: object
      title: (Beta) Amazon S3 authorization parameters.
      description: 'The parameters in the base connection payload which are required to authorize a connection to an Amazon S3 instance.

        '
      required:
      - auth
      - connectionSpec
      properties:
        auth:
          $ref: '#/components/schemas/AmazonS3AuthParameters'
        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.
    Create_S3_Base_Connection_Request_V2:
      type: object
      title: (Beta) Amazon S3 Base Connection Request
      description: 'API request to authorize the connection to an Amazon S3 instance.

        '
      allOf:
      - $ref: '#/components/schemas/GenericBaseConnectionRequest'
      - $ref: '#/components/schemas/AmazonS3SecretAndAccessKeyBaseConnectionRequest_V2'
    Create_SFTP_Base_Connection_Request_V2:
      type: object
      title: (Beta) SFTP Base Connection Request
      description: 'API request to authorize the connection to an SFTP instance that uses password or SSH Key authorization.

        '
      allOf:
      - $ref: '#/components/schemas/GenericBaseConnectionRequest'
      - $ref: '#/components/schemas/SFTPBaseConnectionRequest_V2'