Infoworks

Infoworks Sources API

The Sources API from Infoworks — 8 operation(s) for sources.

Documentation GitHub OpenAPI

Business capability

Information & Data Management BC-610

Operations 11

GET /sources Get list of sources #

POST /sources Create source #

GET /sources/{source_id} Get Source Info #

DELETE /sources/{source_id} Delete source #

PATCH /sources/{source_id} Update source #

GET /sources/{source_id}/source_tables Browse source #

POST /sources/{source_id}/tables/query_tables Add query tables #

GET /sources/{source_id}/crawl-schema Crawl Entity Schema

GET /sources/{source_id}/bulk-crawl-schema Bulk Crawl Entity Schema

GET /sources/{source_id}/crawl-status Check status for crawling

GET /sources/{source_id}/bulk-crawl-status Check status for bulk crawling

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-sources-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

openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Sources 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: Sources
  description: ''
paths:
  /sources:
    parameters:
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      tags:
      - Sources
      summary: Get list of sources
      description: Get list of sources
      operationId: getSourceList
      parameters:
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      - name: resolve_ref
        in: query
        description: To get entity details and created by user name
        schema:
          type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    limit:
                      type: integer
                      example: 10
                    offset:
                      type: integer
                      example: 0
                    links:
                      type: object
                      properties:
                        base:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}
                        self:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0
                        next:
                          type: string
                          format: uri
                          example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10
                    total_count:
                      type: integer
                      example: 10
                  x-examples:
                    example-1: {}
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        allOf:
                        - type: object
                          allOf:
                          - properties:
                              id:
                                type: string
                                example: 354t45656556254564545
                              name:
                                type: string
                                example: sample source
                              type:
                                type: string
                                example: streaming
                              sub_type:
                                type: string
                                example: kafka
                                enum:
                                - kafka
                                - structured
                                - json
                                - xml
                                - unstructured
                                - teradata
                                - redshift
                                - oracle
                                - mysql
                                - mariadb
                                - sqlserver
                                - db2
                                - netezza
                                - saphana
                                - hive
                                - sybaseiq
                                - ignite
                                - vertica
                                - maprdb
                                - mongodb
                                - rest_generic
                                - salesforce
                              data_lake_path:
                                type: string
                                example: /iw/kafka-source
                              use_staging_schema_for_infoworks_managed_tables:
                                type: boolean
                                example: true
                              use_staging_dataset_for_infoworks_managed_tables:
                                type: boolean
                                example: true
                              description:
                                type: string
                                example: example description
                              tags:
                                type: array
                                items:
                                  example: c54t456f6d5a2c4564aed
                              data_lake_schema:
                                type: string
                                example: kafka
                              state:
                                type: string
                                example: ready
                              is_source_ingested:
                                type: boolean
                                example: true
                              is_public:
                                type: boolean
                          - type: object
                            allOf:
                            - type: object
                              properties:
                                created_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                created_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                            - type: object
                              properties:
                                modified_at:
                                  type: string
                                  example: '2019-11-21T12:54:05.875Z'
                            - type: object
                              properties:
                                modified_by:
                                  type: string
                                  example: 6RkfybTRQQByEey3v
                        - properties:
                            tables:
                              type: array
                              items:
                                type: string
                                example: c74a5abb4854ac0a70206f00
                        - type: object
                          properties:
                            environment:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: 63cd71df9f1c1e258c6e991b
                                name:
                                  type: string
                                  example: env_azure
                                compute_engine:
                                  type: string
                                  example: spark
                                platform:
                                  type: string
                                  example: databricks
                            ephemeral_compute:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    example: ephemeral_compute
                                  environment_id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                                  id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                            interactive_compute:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    example: interactive_compute
                                  environment_id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                                  id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                            storage:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                                  name:
                                    type: string
                                    example: storage
                                  environment_id:
                                    type: string
                                    example: 63cd71df9f1c1e258c6e991b
                                  description:
                                    type: string
                                    example: description for storage
                                  storage_type:
                                    type: string
                                    example: gcs
                                  storage_authentication:
                                    type: object
                                    properties:
                                      authentication_mechanism:
                                        type: string
                                        example: environment_service_credential
                                      scheme:
                                        type: string
                                        example: gs://
                                      bucket_name:
                                        type: string
                                        example: temp-bucket-xxx
                        - type: object
                          properties:
                            environment_id:
                              type: string
                              example: 5fda050e7758f32604184d38
                            storage_id:
                              type: string
                              example: 5fda050e7758f32604184d38
                            is_generic_jdbc_source_type:
                              type: boolean
                              example: false
        '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
    post:
      security:
      - BearerAuth: []
      tags:
      - Sources
      summary: Create source
      description: Create source
      operationId: createSource
      requestBody:
        description: Source configurations
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  name:
                    type: string
                  environment_id:
                    type: string
                  storage_id:
                    type: string
                  data_lake_schema:
                    type: string
                  data_lake_path:
                    type: string
                  type:
                    type: string
                  is_source_ingested:
                    type: boolean
                  storage:
                    type: string
                  is_public:
                    type: boolean
                  sub_type:
                    type: string
                    enum:
                    - redshift
                    - saphana
                    - sybaseiq
                    - vertica
                    - mongodb
                    - rest_generic
                  is_oem_connector:
                    type: boolean
                  connection:
                    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
          

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