Adobe Suite Connections API

openapi: 3.2.0
info:
  title: Adobe Suite Connections API
  version: '1.0'
  description: 'Operations tagged Connections across 2 of this provider''s published API definitions: adobe-suite-aep-flow-service-openapi.yaml, adobe-suite-aep-query-service-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: //{environment}.adobe.io/data/foundation/flowservice
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
- url: //{environment}.adobe.io/data/foundation/query
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- name: Connections
  description: Base connections retain information between your source and Adobe Experience Platform. They include metadata, a partial view of the credentials used to authenticate a given source, and the unique base connection ID that corresponds to the queried connection. The base connection ID is required to create a source connection. The base connection ID represents your authenticated connection and allows you to explore and inspect the type, structure, and contents of the data that you want to bring to Experience Platform. An instance of a base connection is specific to an organization.
paths:
  /connections:
    get:
      tags:
      - Connections
      summary: List connections
      description: Retrieve a list of base connections in your organization by making a GET request to the `/connections` endpoint.
      operationId: listConnections
      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: property
        in: query
        description: A comma-separated list of top-level object properties to be returned in the response. This parameter is used to filter the response data based on the properties provided. For example, `property=lastRunDetails.startedAtUTC>=1670880253121` returns only the flows whos last run iterations were started during or after the specified epoch time in milliseconds. This parameter is also used to cut down the amount of data returned in the response body. For example, `property=state==enabled&orderby=createdAt` returns only base connections that have a status of `enabled` in the order of their creation, in ascending order.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      - name: limit
        in: query
        description: Restrict the maximum number of items returned for a given request. For example, adding a parameter of `limit=10` in a request to retrieve all base connections returns only a maximum of 10 base connections. When used to query the API, the returned response automatically includes a `continuationToken` that can be used to fetch records that were not returned due to the limits applied by the parameter.
        schema:
          type: integer
      - name: orderby
        in: query
        description: Sort the listed resources by specified fields. For example, `orderby=name` sorts results by name in ascending order (A-Z). Adding a dash (`-`) before the field name (`orderby=-name`) sorts the results in descending order (Z-A).
        schema:
          type: string
      - name: continuationToken
        in: query
        description: An auto-generated string token that is appended to a returned response when there are more results to be read beyond the maximum count of items that can be returned.
        schema:
          type: string
      - name: count
        in: query
        description: A boolean value specifying if the count of resources should be returned. By default the count is not returned (`count=false`)
        schema:
          type: boolean
          default: false
      responses:
        '200':
          x-summary: Success
          description: Successful operation. A successful response returns a list of base connections that match the request parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionListResponse'
        '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: {}
    post:
      tags:
      - Connections
      summary: Create a new connection
      description: Create a new base connection by making a POST request to the `/connections` endpoint while providing a name for your base connection, your source's corresponding authentication parameters, and your source's unique connection specification ID.
      operationId: createConnection
      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
      requestBody:
        description: "- **name** - **(Required)** The name of your base connection. Ensure that the name of your base connection is descriptive as you can use this to look up information on your base connection.\n- **description** - An optional value that you can include to provide more information on your base connection.\n- **auth** - **(Required)** Contains information necessary to authenticate a base connection.\n  - **specName** - **(Required)** Specifies the name of the the type of authentication to be used with the base connection.\n  - **params** - **(Required)** Contains credentials and values necessary to authenticate and create a connection.\n              \n- **connectionSpec** - **(Required)** Contains information regarding the source's connection specification ID.\n  - **id** - **(Required)** The specific connection specification ID associated with source.\n  - **version** - Specifies the version of the connection specification ID. Omitting this value will default to the most recent version"
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest'
        required: true
      responses:
        '201':
          description: Returns a new base connection ID and its corresponding etag.
          x-summary: Success - Connection Created
          headers:
            Location:
              description: Location of the newly created connection instance
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectionResponse'
              example:
                id: 69f188b6-af07-4587-8061-e94d34637b41
                etag: '"6802064a-0000-0200-0000-6387c6b90000"'
        '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
  /connections/{BASE_CONNECTION_ID}:
    get:
      tags:
      - Connections
      summary: Retrieve a base connection
      description: Use this endpoint to retrieve a single base connection.
      operationId: retrieveConnection
      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: BASE_CONNECTION_ID
        in: path
        description: The ID of the base connection you want to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation. A successful response returns the queried base connection ID in JSON format.
          x-summary: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionListResponse'
        '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: {}
    servers:
    - url: //{environment}.adobe.io/data/foundation/flowservice
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /connections/{BASE_CONNECTION_ID}/test:
    get:
      tags:
      - Connections
      summary: Test a base connection's connectivity
      description: Use this endpoint to test the connectivity of an existing base connection.
      operationId: testConnection
      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: BASE_CONNECTION_ID
        in: path
        description: The ID of the base connection you want to test.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation. A successful response returns `true` if the queried base connection is valid. Returns `false` if the queried base connection is invalid.
          x-summary: Connection Validity Checked
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectionResponse'
        '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: {}
    servers:
    - url: //{environment}.adobe.io/data/foundation/flowservice
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /connections/{BASE_CONNECTION_ID}/explore:
    get:
      tags:
      - Connections
      summary: Explore a connection's contents
      description: Use this endpoint to explore the data structure and contents of a base connection.
      operationId: getByConnectionId
      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: BASE_CONNECTION_ID
        in: path
        description: The ID of the connection you want to explore.
        required: true
        schema:
          type: string
      - name: objectType
        in: query
        description: object Type
        required: false
        schema:
          type: string
          enum:
          - ROOT
          - TABLE
          - FILE
          - FOLDER
          - REST
      - name: object
        in: query
        description: Path or TableName
        required: false
        schema:
          type: string
      - name: FileType
        in: query
        description: object Type
        required: false
        schema:
          type: string
          enum:
          - Delimited
          - JSON
      - name: CompressionType
        in: query
        description: The compression type used to compress the file.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful operation. A successful response returns the file structure of a specified base connection ID, including details regarding type, name, path and whether the file can be previewed or fetched.
          x-summary: File Structure Retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExploreConnectionResponse'
        '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: {}
    servers:
    - url: //{environment}.adobe.io/data/foundation/flowservice
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /connections/{BASE_CONNECTION_ID}/action:
    post:
      tags:
      - Connections
      summary: Perform a state transition action on an existing connection.
      description: Use this endpoint to update the state of an existing connection.
      operationId: performAction
      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: BASE_CONNECTION_ID
        in: path
        description: The ID of the base connection.
        required: true
        schema:
          type: string
      - name: op
        in: query
        description: The operation action to be performed against the base connection.
        required: true
        schema:
          type: string
          enum:
          - FINALIZE_UPDATE
          - FINALIZE
          - PUBLISH
      - name: subOp
        in: query
        description: The sub-operation action to be performed against the base connection.
        required: true
        schema:
          type: array
          items:
            type: string
            enum:
            - APPLY
            - ROLLBACK
            - PROGRESS
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StateActionDTO'
      responses:
        '200':
          x-summary: Success
          description: Successful operation. A successful response returns the updated base connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateConnectionResponse'
        '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
  /connections/{BASE_CONNECTION_ID}/:
    delete:
      tags:
      - Connections
      summary: Delete an existing connection
      description: Use this endpoint to delete a single base connection.
      operationId: deleteConnection
      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: BASE_CONNECTION_ID
        in: path
        description: The ID of the connection you want to delete.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Connection successfully deleted (No content).
          x-summary: 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:
      - Connections
      summary: Update an existing connection
      description: Use this endpoint to update details of an existing base connection.
      operationId: patchConnection
      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: BASE_CONNECTION_ID
        in: path
        description: The {BASE_CONNECTION_ID} 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** - **(Required)** The path of the parameter to be updated.

          **value** - **(Required)** The new value you want to update your parameter with.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchInstruction'
        required: true
      responses:
        '200':
          description: Successful operation. A successful response returns the updated base connection.
          x-summary: Connection Updated
          content:
            application/json:
              example:
                id: 69f188b6-af07-4587-8061-e94d34637b41
                etag: '"6802064a-0000-0200-0000-6387c6b90000"'
        '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
  /connections/{BASE_CONNECTION_ID}/configs:
    get:
      tags:
      - Connections
      summary: Retrieve configs for the properties of a given connection.
      description: Use this endpoint to retrieve the configs of a given connection.
      operationId: exploreConfigByConnectionId
      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: BASE_CONNECTION_ID
        in: path
        description: The ID of the base connection to query.
        required: true
        schema:
          type: string
      responses:
        '200':
          x-summary: Success
          description: Successful operation. A successful response returns the configs of the queried base connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExploreConnectionResponse'
              examples:
                success:
                  value:
                    items:
                    - columnName: name
                      columnType: string
                    - columnName: address
                      columnType: string
                    - columnName: dob
                      columnType: date
                    - columnName: phone
                      columnType: string
        '400':
          description: The request is invalid.
        '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
  /connections/search:
    post:
      tags:
      - Connections
      summary: Retrieve a list of connections based on a given filtering criteria.
      description: Use this endpoint to retrieve a list of connections given a particular filtering criteria.
      operationId: getConnectionsByFilters
      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: continuationToken
        in: query
        descripti

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/adobe-suite/refs/heads/main/openapi/adobe-suite-connections-api-openapi.yml