Infoworks Pipelines API

The Pipelines API from Infoworks — 22 operation(s) for pipelines.

Documentation GitHub OpenAPI

Business capability

Operations 30

GET /admin/pipelines Get all pipelines of all domains #

POST /domains/{domain_id}//pipelines/{pipeline_id}/versions/{version_id}/set-active Change the active version of the Pipeline #

GET /domains/{domain_id}/pipelines Get all pipelines for domain with `domain_id` #

POST /domains/{domain_id}/pipelines create new pipeline for domain with `domain_id` #

GET /domains/{domain_id}/pipelines/{pipeline_id} Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`. #

DELETE /domains/{domain_id}/pipelines/{pipeline_id} Deletes a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`. #

PUT /domains/{domain_id}/pipelines/{pipeline_id} Updates a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`. #

GET /domains/{domain_id}/pipelines/{pipeline_id}/impacted-workflows Gets list of workflows using pipeline with `{pipeline_id}` in `domain` with `{domain_id}`. #

GET /domains/{domain_id}/pipelines/{pipeline_id}/analytics-models Gets all `pipeline analytics models` for ML Engine with `{pipeline_id}` in `domain` with `{domain_id}`. #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions Get list of all versions of Pipeline #

POST /domains/{domain_id}/pipelines/{pipeline_id}/versions Create a pipeline version #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id} Gets a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`. #

DELETE /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id} Deletes a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`. #

PATCH /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id} Update a `pipelineVersion` with `pipeline_version_id` of `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`. #

POST /domains/{domain_id}/pipelines/{pipeline_id}/sql-import #

GET /domains/{domain_id}/pipelines/{pipeline_id}/config-migration Exports the pipeline configuration #

POST /domains/{domain_id}/pipelines/{pipeline_id}/config-migration Imports the pipeline configuration #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/lineage Gets lineage for Pipeline Column. #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/validate Validate a pipeline #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/refresh-sample-data Refresh sample data #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/schema Get node schema #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/data Get node data #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/query Get node query #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{pipeline_version_id}/nodes/{node_id}/sql-inspection Get target SQL preview #

GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/pipeline-version-audits Get Pipeline Version Audit Logs. #

PATCH /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/pipeline-version-audits Update Pipeline Version Audit Logs #

GET /domains/{domain_id}/pipelines/{pipeline_id}/pipeline-audits Get Pipeline Version Audit Logs. #

GET /domains/{domain_id}/accessible-tables-pipeline-sources getTablesfromPipelineSources #

PUT /domains/{domain_id}/pipelines/{pipeline_id}/upload-sql-file-pipeline File upload sql pipeline migration #

PUT /domains/{domain_id}/pipelines/{pipeline_id}/import-sql-mappings Import sql pipeline migration #

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-pipelines-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 Pipelines 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: Pipelines
  description: ''
paths:
  /admin/pipelines:
    get:
      security:
      - BearerAuth: []
      operationId: getPipelinesOfAllDomains
      tags:
      - Pipelines
      summary: Get all pipelines of all domains
      description: Get all pipelines of all domains
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - 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
      responses:
        '200':
          description: Success
          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
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                        - type: object
                          properties:
                            id:
                              type: string
                              example: ffb38b0cc595cfcd05c54e49
                            name:
                              type: string
                              example: test_pipeline
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}//pipelines/{pipeline_id}/versions/{version_id}/set-active:
    post:
      security:
      - BearerAuth: []
      operationId: setPipelineVersionActive
      tags:
      - Pipelines
      summary: Change the active version of the Pipeline
      description: Change the active version of the Pipeline
      parameters:
      - name: filter
        in: query
        description: Filter results query
        schema:
          type: string
      - 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: order_by
        in: query
        description: order  ascending | descending
        schema:
          type: string
          default: asc
          enum:
          - asc
          - desc
      - name: sort_by
        in: query
        description: Sort result on field
        schema:
          type: string
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - name: pipeline_id
        in: path
        required: true
        schema:
          type: string
      - name: version_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines:
    parameters:
    - name: domain_id
      in: path
      required: true
      schema:
        type: string
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    get:
      security:
      - BearerAuth: []
      operationId: getDomainPipelines
      tags:
      - Pipelines
      summary: Get all pipelines for domain with `domain_id`
      description: Get all pipelines for domain with `domain_id`
      parameters:
      - name: offset
        in: query
        description: The number of items to skip before starting to collect the result set
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: The numbers of items to return
        schema:
          type: integer
          default: 10
      - 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
      responses:
        '200':
          description: Success
          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
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                        - type: object
                          properties:
                            domain_id:
                              type: string
                              example: ffb38b0cc595cfcd05c54e49
                            name:
                              type: string
                              example: test_pipeline
                            batch_engine:
                              type: string
                              example: SPARK
                            environment_id:
                              type: string
                              example: eab81a8118141ca6bdd5b698
                            environment_name:
                              type: string
                              example: bigquery_environment
                        - 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
                - 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
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
    post:
      security:
      - BearerAuth: []
      operationId: createPipeline
      tags:
      - Pipelines
      summary: create new pipeline for domain with `domain_id`
      description: create new pipeline for domain with `domain_id`
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                batch_engine:
                  type: string
                  enum:
                  - SPARK
                  - BIGQUERY
                  - SNOWFLAKE
                storage_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                compute_template_id:
                  type: string
                  example: e77850ad5127a2d7dab870ff
                ml_engine:
                  type: string
                  enum:
                  - SPARK
                snowflake_profile:
                  type: string
                  example: profile1
                snowflake_warehouse:
                  type: string
                  example: LOAD_WH
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          type: string
                          example: e77850ad5127a2d7dab870ff
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10006
        '401':
          description: Authentication Failed. Please check your Credentials
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10005
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10005
        '403':
          description: Forbidden. User lacks access to specified resource.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10004
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10004
        '500':
          description: Internal Server Error.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10002
                    help:
                      type: string
                      example: http://api.infoworks.io/help/IW10002
  /domains/{domain_id}/pipelines/{pipeline_id}:
    parameters:
    - name: domain_id
      in: path
      required: true
      schema:
        type: string
    - name: pipeline_id
      in: path
      required: true
      schema:
        type: string
    - name: Content-Type
      in: header
      description: Http content type
      required: true
      schema:
        type: string
        enum:
        - application/json
        - multipart/form-data
        - text/plain
        default: application/json
    get:
      security:
      - BearerAuth: []
      operationId: getPipeline
      tags:
      - Pipelines
      summary: Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
      description: Gets a `pipeline` with `{pipeline_id}` in `domain` with `{domain_id}`.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      allOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                      - type: object
                        properties:
                          name:
                            type: string
                            example: test_pipeline
                          description:
                            type: string
                            example: test description
                          active_version_id:
                            type: string
                            example: 5fda1077e27e6d13330e99c0
                          compute_template_id:
                            type: string
                            example: 5fda1077e27e6d13330e99c0
                          domain_id:
                            type: string
                            example: 5fda1077e27e6d13330e99c0
                          batch_engine:
                            type: string
                            example: SPARK
                          versions_count:
                            type: integer
                            format: int32
                            example: 2
                          metadata_version:
                            type: integer
                            format: int32
                            example: 3
                      - 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
        '400':
          description: Request has invalid body or parameters.
          content:
            application/json:
              schema:
                type: object
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Something went wrong
                    details:
                      type: object
                      properties: {}
                - type: object
                  properties:
                    iw_code:
                      type: string
                      example: IW10006
                    help:
                      type: string
                      example: http:/

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