Coactive connections > connections API

openapi: 3.2.0
info:
  title: Reference connections > connections API
  version: 1.0.0
servers:
- url: https://api.coactive.ai
  description: Production
- url: https://app.coactive.ai
  description: Production
tags:
- name: connections > connections
paths:
  /api/v0/connections:
    post:
      operationId: connections_connections_create_connection_api_v0_connections_post
      summary: Create Connection
      description: Create a new connection to an external data source
      tags:
      - connections > connections
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_GetConnectionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connections_Connections_create_connection_api_v0_connections_post_Request'
      security:
      - HTTPBearer: []
    get:
      operationId: connections_connections_list_connections_api_v0_connections_get
      summary: List Connections
      description: List all connections with optional filtering
      tags:
      - connections > connections
      parameters:
      - name: status
        in: query
        description: Filter by connection status
        required: false
        schema:
          oneOf:
          - $ref: '#/components/schemas/connections_ConnectionStatus'
          - type: 'null'
      - name: connection_type
        in: query
        description: Filter by connection type
        required: false
        schema:
          oneOf:
          - $ref: '#/components/schemas/connections_ConnectionType'
          - type: 'null'
      - name: offset
        in: query
        description: Number of items to skip
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: Maximum number of items to return
        required: false
        schema:
          type: integer
          default: 100
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_ListConnectionsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              type:
              - array
              - 'null'
              items:
                type: string
                format: uuid
      security:
      - HTTPBearer: []
  /api/v0/connections/{connection_name_or_id}:
    delete:
      operationId: connections_connections_delete_connection_api_v0_connections__connection_name_or_id__delete
      summary: Delete Connection
      description: Delete a connection
      tags:
      - connections > connections
      parameters:
      - name: connection_name_or_id
        in: path
        description: The connection name or UUID
        required: true
        schema:
          $ref: '#/components/schemas/connections_ApiV0ConnectionsConnectionNameOrIdDeleteParametersConnectionNameOrId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_GetConnectionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      security:
      - HTTPBearer: []
    get:
      operationId: connections_connections_get_connection_api_v0_connections__connection_name_or_id__get
      summary: Get Connection
      description: Retrieve a connection by name or ID
      tags:
      - connections > connections
      parameters:
      - name: connection_name_or_id
        in: path
        description: The connection name or UUID
        required: true
        schema:
          $ref: '#/components/schemas/connections_ApiV0ConnectionsConnectionNameOrIdGetParametersConnectionNameOrId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_GetConnectionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      security:
      - HTTPBearer: []
    patch:
      operationId: connections_connections_update_connection_api_v0_connections__connection_name_or_id__patch
      summary: Update Connection
      description: Update a connection's name or description
      tags:
      - connections > connections
      parameters:
      - name: connection_name_or_id
        in: path
        description: The connection name or UUID
        required: true
        schema:
          $ref: '#/components/schemas/connections_ApiV0ConnectionsConnectionNameOrIdPatchParametersConnectionNameOrId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_GetConnectionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connections_UpdateConnectionRequest'
      security:
      - HTTPBearer: []
  /api/v0/connections/{connection_name_or_id}/credentials:
    get:
      operationId: connections_connections_get_connection_credentials_api_v0_connections__connection_name_or_id__credentials_get
      summary: Get Connection Credentials
      description: Get temporary AWS credentials for a connection
      tags:
      - connections > connections
      parameters:
      - name: connection_name_or_id
        in: path
        description: The connection name or UUID
        required: true
        schema:
          $ref: '#/components/schemas/connections_ApiV0ConnectionsConnectionNameOrIdCredentialsGetParametersConnectionNameOrId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_GetConnectionCredentialsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v0/connections/{connection_name_or_id}/list:
    post:
      operationId: connections_connections_list_with_connection_api_v0_connections__connection_name_or_id__list_post
      summary: List With Connection
      description: List S3 bucket contents using the connection credentials
      tags:
      - connections > connections
      parameters:
      - name: connection_name_or_id
        in: path
        description: The connection name or UUID
        required: true
        schema:
          $ref: '#/components/schemas/connections_ApiV0ConnectionsConnectionNameOrIdListPostParametersConnectionNameOrId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_ListWithConnectionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connections_ListWithConnectionRequest'
      security:
      - HTTPBearer: []
  /api/v0/connections/{connection_name_or_id}/test:
    post:
      operationId: connections_connections_test_connection_api_v0_connections__connection_name_or_id__test_post
      summary: Test Connection
      description: Test a connection to verify it works correctly
      tags:
      - connections > connections
      parameters:
      - name: connection_name_or_id
        in: path
        description: The connection name or UUID
        required: true
        schema:
          $ref: '#/components/schemas/connections_ApiV0ConnectionsConnectionNameOrIdTestPostParametersConnectionNameOrId'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_GetConnectionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connections_HTTPValidationError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connections_TestConnectionRequest'
      security:
      - HTTPBearer: []
components:
  schemas:
    connections_ApiV0ConnectionsConnectionNameOrIdListPostParametersConnectionNameOrId:
      oneOf:
      - type: string
        format: uuid
      - type: string
      title: ApiV0ConnectionsConnectionNameOrIdListPostParametersConnectionNameOrId
    connections_ConnectionStatus:
      type: string
      enum:
      - pending
      - ready
      - error
      description: The status of a connection
      title: ConnectionStatus
    connections_AWSIAMRoleConfig:
      type: object
      properties:
        iam_role_arn:
          type: string
          pattern: ^arn:aws:iam::\d{12}:role\/[\w+=,.@\-_/]+$
          description: The ARN of the IAM role to assume
        scope:
          $ref: '#/components/schemas/connections_AWSIAMRoleScope'
          description: The scope of permissions for the IAM role. Defaults to s3.
        bucket_name:
          type:
          - string
          - 'null'
          pattern: ^[a-z0-9][a-z0-9\.\-]+[a-z0-9]
          minLength: 3
          maxLength: 63
          description: The S3 bucket name associated with this connection
        session_ttl_seconds:
          type: integer
          minimum: 60
          maximum: 3600
          default: 3600
          description: Session duration in seconds (60-3600)
      required:
      - iam_role_arn
      title: AWSIAMRoleConfig
    connections_HTTPSBearerAuthConfig:
      type: object
      properties:
        hostname:
          type: string
          pattern: ^[a-z0-9][a-z0-9\.\-]+[a-z0-9]$
          minLength: 1
          maxLength: 255
          description: The hostname to connect to
        bearer_token:
          type: string
          minLength: 1
          maxLength: 255
          description: The bearer token for authentication
      required:
      - hostname
      - bearer_token
      title: HTTPSBearerAuthConfig
    connections_ApiV0ConnectionsConnectionNameOrIdGetParametersConnectionNameOrId:
      oneOf:
      - type: string
        format: uuid
      - type: string
      title: ApiV0ConnectionsConnectionNameOrIdGetParametersConnectionNameOrId
    connections_ApiV0ConnectionsConnectionNameOrIdTestPostParametersConnectionNameOrId:
      oneOf:
      - type: string
        format: uuid
      - type: string
      title: ApiV0ConnectionsConnectionNameOrIdTestPostParametersConnectionNameOrId
    connections_PagedLinksDetailsResponse:
      type: object
      properties:
        current:
          type: string
          description: The current page link
        previous:
          type:
          - string
          - 'null'
          description: The previous page, if applicable
        next:
          type:
          - string
          - 'null'
          description: The next page link, if applicable
      required:
      - current
      - previous
      - next
      description: Pagination metadata
      title: PagedLinksDetailsResponse
    connections_CreateAWSConnectionRequest:
      type: object
      properties:
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9_]+[a-z0-9]
          minLength: 3
          maxLength: 255
          description: The connection name (3-255 characters, lowercase alphanumeric with underscores)
        description:
          type:
          - string
          - 'null'
          description: Optional description for the connection
        test_location:
          type:
          - string
          - 'null'
          description: Optional location to test the connection
        type:
          $ref: '#/components/schemas/connections_ConnectionType'
        config:
          $ref: '#/components/schemas/connections_AWSIAMRoleConfig'
      required:
      - name
      - config
      title: CreateAWSConnectionRequest
    connections_CreateHTTPSBasicAuthConnectionRequest:
      type: object
      properties:
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9_]+[a-z0-9]
          minLength: 3
          maxLength: 255
          description: The connection name (3-255 characters, lowercase alphanumeric with underscores)
        description:
          type:
          - string
          - 'null'
          description: Optional description for the connection
        test_location:
          type:
          - string
          - 'null'
          description: Optional location to test the connection
        type:
          $ref: '#/components/schemas/connections_ConnectionType'
        config:
          $ref: '#/components/schemas/connections_HTTPSBasicAuthConfig'
      required:
      - name
      - config
      title: CreateHTTPSBasicAuthConnectionRequest
    connections_GetConnectionResponseConfig:
      oneOf:
      - $ref: '#/components/schemas/connections_HTTPSBasicAuthConfig'
      - $ref: '#/components/schemas/connections_HTTPSBearerAuthConfig'
      - $ref: '#/components/schemas/connections_AWSIAMRoleConfig'
      description: The connection configuration
      title: GetConnectionResponseConfig
    connections_GetConnectionResponse:
      type: object
      properties:
        connection_id:
          type: string
          format: uuid
          description: The unique identifier for the connection
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9_]+[a-z0-9]
          minLength: 3
          maxLength: 255
          description: The connection name
        description:
          type:
          - string
          - 'null'
          description: The connection description
        type:
          $ref: '#/components/schemas/connections_ConnectionType'
          description: The type of connection
        status:
          $ref: '#/components/schemas/connections_ConnectionStatus'
          description: The current status of the connection
        config:
          $ref: '#/components/schemas/connections_GetConnectionResponseConfig'
          description: The connection configuration
        created_dt:
          type: string
          format: date-time
          description: When the connection was created
        updated_dt:
          type: string
          format: date-time
          description: When the connection was last updated
      required:
      - connection_id
      - name
      - type
      - status
      - config
      - created_dt
      - updated_dt
      title: GetConnectionResponse
    connections_UpdateConnectionRequest:
      type: object
      properties:
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9_]+[a-z0-9]
          minLength: 3
          maxLength: 255
          description: The new connection name
        description:
          type:
          - string
          - 'null'
          description: The new connection description
      required:
      - name
      title: UpdateConnectionRequest
    connections_Connections_create_connection_api_v0_connections_post_Request:
      oneOf:
      - $ref: '#/components/schemas/connections_CreateHTTPSBasicAuthConnectionRequest'
      - $ref: '#/components/schemas/connections_CreateHTTPSBearerAuthConnectionRequest'
      - $ref: '#/components/schemas/connections_CreateAWSConnectionRequest'
      title: Connections_create_connection_api_v0_connections_post_Request
    connections_PagedPageDetailsResponse:
      type: object
      properties:
        current_page:
          type: integer
          description: Current page number
        limit:
          type: integer
          description: Number of items returned in the list response
        offset:
          type: integer
          description: Starting index returned for the list response
      required:
      - current_page
      - limit
      - offset
      description: Pagination metadata
      title: PagedPageDetailsResponse
    connections_ListWithConnectionRequest:
      type: object
      properties:
        bucket:
          type: string
          description: The S3 bucket name
        prefix:
          type: string
          description: The S3 prefix to list
        max_keys:
          type: integer
          default: 1000
          description: Maximum number of keys to return
        continuation_token:
          type:
          - string
          - 'null'
          description: Token for paginating results
      required:
      - bucket
      - prefix
      title: ListWithConnectionRequest
    connections_ApiV0ConnectionsConnectionNameOrIdCredentialsGetParametersConnectionNameOrId:
      oneOf:
      - type: string
        format: uuid
      - type: string
      title: ApiV0ConnectionsConnectionNameOrIdCredentialsGetParametersConnectionNameOrId
    connections_ApiV0ConnectionsConnectionNameOrIdDeleteParametersConnectionNameOrId:
      oneOf:
      - type: string
        format: uuid
      - type: string
      title: ApiV0ConnectionsConnectionNameOrIdDeleteParametersConnectionNameOrId
    connections_ConnectionType:
      type: string
      enum:
      - https_basic
      - https_bearer
      - aws_iam_role
      description: The type of connection
      title: ConnectionType
    connections_ListWithConnectionResponse:
      type: object
      properties:
        bucket:
          type: string
          description: The S3 bucket name
        prefix:
          type: string
          description: The S3 prefix that was listed
        keys:
          type: array
          items:
            type: string
          description: The list of object keys
        common_prefixes:
          type: array
          items:
            type: string
          description: Common prefixes (subdirectories)
        continuation_token:
          type:
          - string
          - 'null'
          description: Token for fetching the next page of results
      required:
      - bucket
      - prefix
      - keys
      - common_prefixes
      title: ListWithConnectionResponse
    connections_AWSIAMRoleScope:
      type: string
      enum:
      - s3
      - bedrock
      description: The scope of permissions for an AWS IAM role connection
      title: AWSIAMRoleScope
    connections_HTTPSBasicAuthConfig:
      type: object
      properties:
        hostname:
          type: string
          pattern: ^[a-z0-9][a-z0-9\.\-]+[a-z0-9]$
          minLength: 1
          maxLength: 255
          description: The hostname to connect to
        username:
          type: string
          minLength: 1
          maxLength: 255
          description: The username for authentication
        password:
          type: string
          minLength: 1
          maxLength: 255
          description: The password for authentication
      required:
      - hostname
      - username
      - password
      title: HTTPSBasicAuthConfig
    connections_ApiV0ConnectionsConnectionNameOrIdPatchParametersConnectionNameOrId:
      oneOf:
      - type: string
        format: uuid
      - type: string
      title: ApiV0ConnectionsConnectionNameOrIdPatchParametersConnectionNameOrId
    connections_ListConnectionsResponse:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/connections_PagedMetaResponse'
          description: Metadata for the set of data returned
        data:
          type: array
          items:
            $ref: '#/components/schemas/connections_GetConnectionResponse'
          description: The paginated data
      required:
      - meta
      - data
      title: ListConnectionsResponse
    connections_PagedMetaResponse:
      type: object
      properties:
        page:
          $ref: '#/components/schemas/connections_PagedPageDetailsResponse'
          description: Details about the response page
        links:
          $ref: '#/components/schemas/connections_PagedLinksDetailsResponse'
          description: Links for easy page traversal
      required:
      - page
      - links
      description: Metadata about the paginated response
      title: PagedMetaResponse
    connections_HTTPValidationError:
      type: object
      properties:
        detail:
          type: array
          items:
            $ref: '#/components/schemas/connections_ValidationError'
      title: HTTPValidationError
    connections_ValidationErrorLocItems:
      oneOf:
      - type: string
      - type: integer
      title: ValidationErrorLocItems
    connections_CreateHTTPSBearerAuthConnectionRequest:
      type: object
      properties:
        name:
          type: string
          pattern: ^[a-z0-9][a-z0-9_]+[a-z0-9]
          minLength: 3
          maxLength: 255
          description: The connection name (3-255 characters, lowercase alphanumeric with underscores)
        description:
          type:
          - string
          - 'null'
          description: Optional description for the connection
        test_location:
          type:
          - string
          - 'null'
          description: Optional location to test the connection
        type:
          $ref: '#/components/schemas/connections_ConnectionType'
        config:
          $ref: '#/components/schemas/connections_HTTPSBearerAuthConfig'
      required:
      - name
      - config
      title: CreateHTTPSBearerAuthConnectionRequest
    connections_GetConnectionCredentialsResponse:
      type: object
      properties:
        access_key_id:
          type: string
          description: The AWS access key ID
        secret_access_key:
          type: string
          description: The AWS secret access key
        session_token:
          type: string
          description: The AWS session token
        expires_in:
          type: integer
          description: Number of seconds until the credentials expire
      required:
      - access_key_id
      - secret_access_key
      - session_token
      - expires_in
      title: GetConnectionCredentialsResponse
    connections_ValidationError:
      type: object
      properties:
        loc:
          type: array
          items:
            $ref: '#/components/schemas/connections_ValidationErrorLocItems'
        msg:
          type: string
        type:
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
    connections_TestConnectionRequest:
      type: object
      properties:
        location:
          type: string
          default: /
          description: Specific location to use to test the connection
        update_state:
          type: boolean
          default: true
          description: Set to true update the status of the connection, false to dry run
      title: TestConnectionRequest
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: Coactive
  source: https://docs.coactive.ai/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)