Infoworks

Infoworks Domains API

The Domains API from Infoworks — 21 operation(s) for domains.

GitHub OpenAPI

Operations 40

GET /admin/data-connections/{data_connection_id} Get the Target Data Connection #
PUT /admin/data-connections/{data_connection_id} Edit the Target Data Connections Associated with a Domain #
PATCH /admin/data-connections/{data_connection_id} Patch the Target Data Connection #
DELETE /admin/data-connections/{data_connection_id} Delete the Target Data Connections Associated with a Domain #
GET /admin/domains Get List of Domains #
GET /admin/domains/{domain_id}/accessible-sources-to-add Get List of Domains #
GET /admin/domains/{domain_id}/domain-users Get List of Domains Users #
GET /admin/domains/{domain_id}/accessible-domains-to-add Get List of Accessible Domains #
GET /admin/domains/{domain_id}/accessible-pipeline-extensions-to-add Get List of Domains Pipeline Extensions #
GET /domains Get List of Domains #
POST /domains Add a domain. (Requires Admin Access) #
GET /domains/{domain_id} Get description of a domain_id. (Requires Admin Access) #
PATCH /domains/{domain_id} Edit name and description of a domain. (Requires Admin Access) #
DELETE /domains/{domain_id} Delete a Domain (Requires Admin Access). #
GET /domains/{domain_id}/accessible-sources Get all the Sources associated with this Domain #
POST /domains/{domain_id}/accessible-sources Add Sources to this Domain (Requires Admin Access) #
PUT /domains/{domain_id}/accessible-sources Update Sources to this Domain (Requires Admin Access) #
DELETE /domains/{domain_id}/accessible-sources Remove Source from this Domain (Requires Admin Access) #
GET /domains/{domain_id}/accessible-domains Get all the Domains associated with this Domain #
POST /domains/{domain_id}/accessible-domains Add Domains to this Domain (Requires Admin Access) #
PUT /domains/{domain_id}/accessible-domains Update accessible-domain in this Domain (Requires Admin Access) #
DELETE /domains/{domain_id}/accessible-domains Remove Domain from this Domain (Requires Admin Access) #
GET /domains/{domain_id}/accessible-workflows Get all the workflows associated with this Domain #
GET /domains/{domain_id}/accessible-table-groups Get all the tablegroups associated with this Domain #
GET /domains/{domain_id}/accessible-interactive-computes Get all the interactive computes associated with this Domain #
GET /domains/{domain_id}/accessible-pipelines Get all the pipelines associated with this Domain #
GET /domains/{domain_id}/accessible-pipeline-extensions Get all the Pipeline Extensions associated with this Domain #
PUT /domains/{domain_id}/accessible-pipeline-extensions Update accessible-pipeline-extensions in this Domain (Requires Admin Access) #
POST /domains/{domain_id}/accessible-pipeline-extensions Add Pipeline Extensions to this Domain (Requires Admin Access) #
DELETE /domains/{domain_id}/accessible-pipeline-extensions Remove Pipeline Extension from this Domain (Requires Admin Access) #
PUT /domains/{domain_id}/configurations/advance/{key} #
PATCH /domains/{domain_id}/configurations/advance/{key} #
DELETE /domains/{domain_id}/configurations/advance/{key} #
GET /domains/{domain_id}/recently-used-entities Get recently used entities associated with this Domain #
POST /domains/{domain_id}/recently-used-entities Add Recently Used Entity to this Domain #
GET /domains/{domain_id}/comments Get comments associated with this Domain #
POST /domains/{domain_id}/comments Add comment to this Domain #
GET /domains/{domain_id}/notifications Get notifications associated with this Domain #
GET /domains/{domain_id}/pipelines/{pipeline_id}/versions/{version_id}/node/{node_id} Get Table Orders With Hierachy #
GET /domains/{domain_id}/environment_details_pipelines_accessible_sources Get Domains Pipeline and Accessibele Sources #

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-domains-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-domains-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-domains-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Domains 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: Domains
  description: ''
paths:
  /admin/data-connections/{data_connection_id}:
    parameters:
    - name: data_connection_id
      in: path
      required: true
      schema:
        type: string
    get:
      security:
      - BearerAuth: []
      operationId: getDataConnection
      tags:
      - Domains
      summary: Get the Target Data Connection
      description: Get the Target Data Connection
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - properties:
                    result:
                      allOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            example: e77850ad5127a2d7dab870ff
                      - properties:
                          type:
                            type: string
                            example: SNOWFLAKE
                          name:
                            type: string
                            example: target1
                          connection_url:
                            type: string
                            example: jdbc://admin:xxxx@infoworks.io/
                          account_name:
                            type: string
                            example: pvt_account_1
                          username:
                            type: string
                            example: admin
                          password:
                            type: string
                            example: xxxx
                          warehouse:
                            type: string
                            example: data_warehouse
                          additional_params:
                            type: string
                            example: x=2&&y=4
                      - 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://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
    put:
      security:
      - BearerAuth: []
      operationId: updateDataConnection
      tags:
      - Domains
      summary: Edit the Target Data Connections Associated with a Domain
      description: Edit the Target Data Connections Associated with a Domain
      requestBody:
        content:
          application/json:
            schema:
              properties:
                type:
                  type: string
                  example: SNOWFLAKE
                name:
                  type: string
                  example: target1
                connection_url:
                  type: string
                  example: jdbc://admin:xxxx@infoworks.io/
                account_name:
                  type: string
                  example: pvt_account_1
                username:
                  type: string
                  example: admin
                password:
                  type: string
                  example: xxxx
                warehouse:
                  type: string
                  example: data_warehouse
                additional_params:
                  type: string
                  example: x=2&&y=4
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      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
    patch:
      security:
      - BearerAuth: []
      operationId: patchDataConnection
      tags:
      - Domains
      summary: Patch the Target Data Connection
      description: Patch the Target Data Connection
      requestBody:
        content:
          application/json:
            schema:
              properties:
                type:
                  type: string
                  example: SNOWFLAKE
                name:
                  type: string
                  example: target1
                connection_url:
                  type: string
                  example: jdbc://admin:xxxx@infoworks.io/
                account_name:
                  type: string
                  example: pvt_account_1
                username:
                  type: string
                  example: admin
                password:
                  type: string
                  example: xxxx
                warehouse:
                  type: string
                  example: data_warehouse
                additional_params:
                  type: string
                  example: x=2&&y=4
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      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
    delete:
      security:
      - BearerAuth: []
      operationId: deleteDataConnection
      tags:
      - Domains
      summary: Delete the Target Data Connections Associated with a Domain
      description: Delete the Target Data Connections Associated with a Domain
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      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
  /admin/domains:
    get:
      security:
      - BearerAuth: []
      operationId: getDomains
      tags:
      - Domains
      summary: Get List of Domains
      description: Get List of Domains
      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
      responses:
        '200':
          description: Ok
          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:
                    result:
                      type: array
                      items:
                        allOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                        - allOf:
                          - type: object
                            properties:
                              name:
                                type: string
                                example: DF_SQLIMPORT
                          - type: object
                            properties:
                              description:
                                type: string
                                example: Example Domain
                          - type: object
                            properties:
                              secrets:
                                type: array
                                items:
                                  type: string
                                  example: 8247ad34f124512e
                          - properties:
                              environment_ids:
                                type: array
                                items:
                                  type: string
                                  example: 8247ad34f124512e
                              users:
                                type: array
                                items:
                                  type: string
                                  example: 8247ad34f124512e
                        - 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:
                            accessibleDomains:
                              type: array
                              items:
                                type: string
                                example: 3456234456cde12e
                        - type: object
                          properties:
                            accessiblePipelineExtensions:
                              type: array
                              items:
                                type: string
                                example: 7b606a6c4bc0688a99cc5f07
                        - 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
  /admin/domains/{domain_id}/accessible-sources-to-add:
    parameters:
    - name: domain_id
      in: path
      required: true
 

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