Infoworks

Infoworks Connections API

The Connections API from Infoworks — 1 operation(s) for connections.

GitHub OpenAPI

Operations 2

GET /sources/{source_id}/configurations/connection Get source connection details
PUT /sources/{source_id}/configurations/connection Update an existing source connection

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/authentication/infoworks-authentication.yml
📖
Documentation
https://docs.infoworks.io/developer-resources/rest-api
📖
APIReference
https://docs.infoworks.io/infoworks-rest-api-v3/ref

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/openapi/infoworks-connections-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/errors/infoworks-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/conventions/infoworks-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/infoworks/refs/heads/main/data-model/infoworks-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/infoworks-connections-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

infoworks-connections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Connections API
  version: '1.0'
  description: Infoworks Rest API V3
servers:
- url: '{protocol}://{host}:{port}/v3'
  variables:
    protocol:
      default: http
      enum:
      - http
      - https
    host:
      default: localhost
    port:
      default: '3001'
tags:
- name: Connections
  description: ''
paths:
  /sources/{source_id}/configurations/connection:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    - name: source_id
      in: path
      description: Source Id.
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Connections
      summary: Get source connection details
      description: Get source connection details
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      properties:
                        enable_log_based_cdc:
                          type: boolean
                          example: false
                        driver_name:
                          type: string
                          example: oracle.jdbc.driver.OracleDriver
                        connection_url:
                          type: string
                          example: bc:oracle:thin:@0.0.0.0
                        username:
                          example: automation_db
                        password:
                          oneOf:
                          - type: string
                            minLength: 1
                            example:
                            - passw@rd_plain
                            - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                          - type: object
                            properties:
                              password_type:
                                type: string
                                enum:
                                - infoworks_managed
                              password:
                                type: string
                                minLength: 1
                                example:
                                - passw@rd_plain
                                - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                          - type: object
                            properties:
                              password_type:
                                type: string
                                enum:
                                - secret_store
                              secret_id:
                                type: string
                                example: e77850ad5127a2d7dab870ff
                        source_schema:
                          type: string
                          example: AUTOMATION_DB
                        connection_mode:
                          type: string
                          example: JDBC
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '401':
          description: Unauthorized Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '403':
          description: Forbidden Access
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        message:
                          type: string
                          example: Something went wrong
                        detail:
                          type: object
                          properties: {}
                        help:
                          type: string
                          example: https://docs.infoworks.io/api/errors/IW1004
                        code:
                          type: string
                          example: IW1004
    put:
      security:
      - BearerAuth: []
      tags:
      - Connections
      summary: Update an existing source connection
      description: Update an existing source connection
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - allOf:
                - type: object
                  required:
                  - source_schema
                  - username
                  - password
                  - database
                  properties:
                    connection_mode:
                      type: string
                      example: jdbc
                      enum:
                      - jdbc
                    connection_url:
                      type: string
                      example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                    source_schema:
                      type: string
                      example: test_schema
                    username:
                      type: string
                      example: Lucifer
                    password:
                      oneOf:
                      - type: string
                        minLength: 1
                        example:
                        - passw@rd_plain
                        - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - infoworks_managed
                          password:
                            type: string
                            minLength: 1
                            example:
                            - passw@rd_plain
                            - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - secret_store
                          secret_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                    database:
                      type: string
                      example: automation_db
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
                - type: object
                  properties:
                    enable_log_based_cdc:
                      type: boolean
                      example: true
                    staging_database:
                      type: string
                      example: db_staging
                    enable_dictionary_rebuild_for_each_job:
                      type: boolean
                      example: true
                    dictionary_path:
                      type: string
                      example: /tmp/dict
                    dictionary_type:
                      type: string
                      example: online
                      enum:
                      - online
                      - offline
                      - redo_log
              - allOf:
                - type: object
                  required:
                  - source_schema
                  - username
                  - password
                  - database
                  properties:
                    connection_mode:
                      type: string
                      example: jdbc
                      enum:
                      - jdbc
                    connection_url:
                      type: string
                      example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                    source_schema:
                      type: string
                      example: test_schema
                    username:
                      type: string
                      example: Lucifer
                    password:
                      oneOf:
                      - type: string
                        minLength: 1
                        example:
                        - passw@rd_plain
                        - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - infoworks_managed
                          password:
                            type: string
                            minLength: 1
                            example:
                            - passw@rd_plain
                            - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - secret_store
                          secret_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                    database:
                      type: string
                      example: automation_db
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
              - allOf:
                - type: object
                  required:
                  - source_schema
                  - username
                  - password
                  - database
                  properties:
                    connection_mode:
                      type: string
                      example: jdbc
                      enum:
                      - jdbc
                    connection_url:
                      type: string
                      example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                    source_schema:
                      type: string
                      example: test_schema
                    username:
                      type: string
                      example: Lucifer
                    password:
                      oneOf:
                      - type: string
                        minLength: 1
                        example:
                        - passw@rd_plain
                        - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - infoworks_managed
                          password:
                            type: string
                            minLength: 1
                            example:
                            - passw@rd_plain
                            - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - secret_store
                          secret_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                    database:
                      type: string
                      example: automation_db
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
              - allOf:
                - type: object
                  required:
                  - source_schema
                  - username
                  - password
                  - database
                  properties:
                    connection_mode:
                      type: string
                      example: jdbc
                      enum:
                      - jdbc
                    connection_url:
                      type: string
                      example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                    source_schema:
                      type: string
                      example: test_schema
                    username:
                      type: string
                      example: Lucifer
                    password:
                      oneOf:
                      - type: string
                        minLength: 1
                        example:
                        - passw@rd_plain
                        - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - infoworks_managed
                          password:
                            type: string
                            minLength: 1
                            example:
                            - passw@rd_plain
                            - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - secret_store
                          secret_id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                    database:
                      type: string
                      example: automation_db
                    snowflake_profile:
                      type: string
                      example: profile1
                    warehouse:
                      type: string
                      example: DEMO_WH
                - type: object
                  properties:
                    enable_teradata_wallet:
                      type: boolean
                      example: true
                    teradata_wallet_key_used_for_password:
                      type: string
                    storage:
                      oneOf:
                      - allOf:
                        - type: object
                          properties:
                            storage_type:
                              type: string
                              enum:
                              - dbfs
                              - remote
                              - cloud
                      - allOf:
                        - type: object
                          properties:
                            storage_type:
                              type: string
                              enum:
                              - dbfs
                              - remote
                              - cloud
                        - type: object
                          required:
                          - sftp_host
                          - sftp_port
                          - username
                          - password
                          - auth_type
                          properties:
                            sftp_host:
                              type: string
                              example: 192.168.1.1
                            sftp_port:
                              type: integer
                              example: 22
                            username:
                              type: string
                              example: Lucifer
                            password:
                              oneOf:
                              - type: string
                                minLength: 1
                                example:
                                - passw@rd_plain
                                - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                              - type: object
                                properties:
                                  password_type:
                                    type: string
                                    enum:
                                    - infoworks_managed
                                  password:
                                    type: string
                                    minLength: 1
                                    example:
                                    - passw@rd_plain
                                    - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                              - type: object
                                properties:
                                  password_type:
                                    type: string
                                    enum:
                                    - secret_store
                                  secret_id:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                            auth_type:
                              type: string
                              example: password
                            credential:
                              oneOf:
                              - type: object
                                required:
                                - type
                                - username
                                - password
                                properties:
                                  type:
                                    type: string
                                    example: basic
                                  username:
                                    type: string
                                    example: sftp-user
                                  password:
                                    oneOf:
                                    - type: string
                                      minLength: 1
                                      example:
                                      - passw@rd_plain
                                      - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                          - infoworks_managed
                                        password:
                                          type: string
                                          minLength: 1
                                          example:
                                          - passw@rd_plain
                                          - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                    - type: object
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                          - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                              - type: object
                                required:
                                - type
                                - username
                                - private_key_path
                                - passphrase
                                properties:
                                  type:
                                    type: string
                                    example: key
                                  username:
                                    type: string
                                    example: sftp-user
                                  private_key_path:
                                    type: string
                                    example: /opt/infoworks/key
                                  passphrase:
                                    type: string
                                    example: J9moLFp0XjMhsLu
                      - oneOf:
                        - allOf:
                          - type: object
                            properties:
                              storage_type:
                                type: string
                                enum:
                                - dbfs
                                - remote
                                - cloud
                          - type: object
                            properties:
                              cloud_type:
                                type: string
                                enum:
                                - s3
                                - wasb
                                - gs
                          - type: object
                            required:
                            - type
                            - base_path
                            - credential
                            properties:
                              account_type:
                                type: string
                              access_id:
                                type: string
                              secret_key:
                                oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                  - passw@rd_plain
                                  - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                      - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                      - passw@rd_plain
                                      - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                      - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                              access_type:
                                type: string
                              support_gov_cloud:
                                type: boolean
                              endpoint:
                                type: string
                        - allOf:
                          - type: object
                            properties:
                              storage_type:
                                type: string
                                enum:
                                - dbfs
                                - remote
                                - cloud
                          - type: object
                            properties:
                              cloud_type:
                                type: string
                                enum:
                                - s3
                                - wasb
                                - gs
                          - type: object
                            properties:
                              access_type:
                                type: string
                                example: service_account
                                enum:
                                - service_account
                              project_id:
                                type: string
                                example: csv_store
                              upload_option:
                                type: string
                                enum:
                                - fileUpload
                                - serverLocation
                                example: fileUpload
                              server_path:
                                type: string
                                description: required if upload_option is set to serverLocation
                                example: /opt/infoworks/uploads/ccd2d7144f74b382357e5f5f/key.json
                        - allOf:
                          - type: object
                            properties:
                              storage_type:
                                type: string
                                enum:
                                - dbfs
                                - remote
                                - cloud
                          - type: object
                            properties:
                              cloud_type:
                                type: string
                                enum:
                                - s3
                                - wasb
                                - gs
                          - type: object
                            properties:
                              account_name:
                                type: string
                              account_key:
                                oneOf:
                                - type: string
                                  minLength: 1
                                  example:
                                  - passw@rd_plain
                                  - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                      - infoworks_managed
                                    password:
                                      type: string
                                      minLength: 1
                                      example:
                                      - passw@rd_plain
                                      - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                                - type: object
                                  properties:
                                    password_type:
                                      type: string
                                      enum:
                                      - secret_store
                                    secret_id:
                                      type: string
                                      example: e77850ad5127a2d7dab870ff
                              account_endpoint:
                                type: string
                              container_name:
                                type: string
                              support_gov_cloud:
                                type: boolean
                              access_type:
                                type: string
                                enum:
                                - none
                                - account_key
                    enable_ingestion_via_tpt:
                      type: boolean
                      example: true
                    is_td_wallet_enabled:
                      type: boolean
                      example: true
                    enable_tpt_for_source:
                      type: boolean
                      example: true
              - allOf:
                - type: object
                  required:
                  - source_schema
                  - username
                  - password
                  - database
                  properties:
                    connection_mode:
                      type: string
                      example: jdbc
                      enum:
                      - jdbc
                    connection_url:
                      type: string
                      example: jdbc:teradata://ip/TMODE=ANSIdatabase=automation_db
                    source_schema:
                      type: string
                      example: test_schema
                    username:
                      type: string
                      example: Lucifer
                    password:
                      oneOf:
                      - type: string
                        minLength: 1
                        example:
                        - passw@rd_plain
                        - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
                        properties:
                          password_type:
                            type: string
                            enum:
                            - infoworks_managed
                          password:
                            type: string
                            minLength: 1
                            example:
                            - passw@rd_plain
                            - gIcfY/8lztYzmtrVX0dI/n+DD7RhkOqOtDJnIXXLydMYG1CgCX5fPn0gQkRhC3o=
                      - type: object
       

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