openapi: 3.0.3
info:
  title: Talend Cloud Orchestration Artifacts Connections API
  description: The Talend Cloud Orchestration API manages tasks, plans, schedules, workspaces, environments, artifacts, connections, promotions, and resources in Qlik Talend Cloud. Use this API to automate data integration pipeline management, configure execution schedules, and manage workspace resources.
  version: 2021-03
  contact:
    name: Qlik Talend Support
    url: https://talend.qlik.dev
  termsOfService: https://www.qlik.com/us/legal/license-terms
servers:
- url: https://api.{region}.cloud.talend.com
  description: Talend Cloud API
  variables:
    region:
      description: Cloud region
      default: eu
      enum:
      - eu
      - us
      - us-west
      - ap
      - au
security:
- BearerAuth: []
tags:
- name: Connections
paths:
  /orchestration/connections:
    get:
      operationId: listConnections
      summary: List Connections
      description: Retrieve all connections configured in the account
      tags:
      - Connections
      responses:
        '200':
          description: List of connections
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Connection'
    post:
      operationId: createConnection
      summary: Create Connection
      description: Create a new data source connection
      tags:
      - Connections
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionCreate'
      responses:
        '201':
          description: Connection created
components:
  schemas:
    Connection:
      type: object
      description: A data source or destination connection configuration
      properties:
        id:
          type: string
        name:
          type: string
        workspaceId:
          type: string
        type:
          type: string
          description: Connection type (e.g., JDBC, S3, Snowflake)
        created:
          type: string
          format: date-time
    ConnectionCreate:
      type: object
      required:
      - name
      - workspaceId
      - type
      properties:
        name:
          type: string
        workspaceId:
          type: string
        type:
          type: string
        configuration:
          type: object
          additionalProperties: true
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer token from Talend Cloud personal access token or service account token
externalDocs:
  description: Talend Orchestration API Documentation
  url: https://talend.qlik.dev/apis/orchestration/2021-03/