Infoworks Workflows API

The Workflows API from Infoworks — 20 operation(s) for workflows.

Documentation GitHub OpenAPI

Operations 24

GET /domains/{domain_id}/workflows Get list of all Workflows for a `domain` with `{domain_id}`. #

POST /domains/{domain_id}/workflows Create Workflow for a `domain` with `{domain_id}`. #

GET /domains/{domain_id}/workflows/{workflow_id} Gets a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. #

DELETE /domains/{domain_id}/workflows/{workflow_id} Deletes a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. #

PATCH /domains/{domain_id}/workflows/{workflow_id} Update a `workflow` with `{workflow_id}` in `domain` with `{domain_id}`. #

GET /domains/{domain_id}/workflows/{workflow_id}/config-migration Exports workflow configuration #

PUT /domains/{domain_id}/workflows/{workflow_id}/config-migration Imports workflow configuration #

POST /domains/{domain_id}/workflows/{workflow_id}/start Runs the latest workflow #

POST /domains/{domain_id}/workflows/{workflow_id}/pause This will pause all running builds of `workflow` with `{workflow_id}`. #

POST /domains/{domain_id}/workflows/{workflow_id}/resume This will resume all paused builds of `workflow` with `{workflow_id}`. #

GET /domains/{domain_id}/workflows/{workflow_id}/lineage Get workflow lineage #

GET /domains/{domain_id}/workflows/{workflow_id}/ancestors Get workflow ancestors #

GET /domains/{domain_id}/workflows/{workflow_id}/runs This will get all builds of `workflow` with `{workflow_id}`. #

GET /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id} This will get a specific build of `workflow` with `{workflow_id}`. #

POST /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/restart This will restart running `workflow` with `{workflow_id}`. #

POST /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/cancel This will cancel running `workflow` with `{workflow_id}` for build with `workflow_run_id`. #

GET /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs Get task logs for a workflow run #

GET /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/logs/download Download task logs for a workflow run #

GET /domains/{domain_id}/workflows/{workflow_id}/parents Gets parents workflow details of the workflow #

POST /domains/{domain_id}/workflows/{workflow_id}/runs/{workflow_run_id}/tasks/{task_id}/variables Set workflow variables for a task in a workflow run #

POST /prodops/workflow_runs Get Workflows

GET /prodops/workflow_runs/{run_id}/jobs Retrieves the job details #

POST /prodops/workflows/restart Restart Multiple Workflows #

POST /prodops/workflows/cancel Cancel Multiple Workflows #

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-workflows-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 Workflows 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: Workflows
  description: ''
paths:
  /domains/{domain_id}/workflows:
    get:
      security:
      - BearerAuth: []
      operationId: getDomainWorkflows
      tags:
      - Workflows
      summary: Get list of all Workflows for a `domain` with `{domain_id}`.
      description: Get list of all Workflows for a `domain` with `{domain_id}`.
      parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: string
      - 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
      - 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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - 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:
                        - allOf:
                          - allOf:
                            - type: object
                              properties:
                                name:
                                  type: string
                                description:
                                  type: string
                                active_version_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                child_workflow_ids:
                                  type: array
                                  items:
                                    type: string
                                    example: e77850ad5127a2d7dab870ff
                                impact:
                                  type: number
                            - type: object
                              properties:
                                domain_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                scheduler_username:
                                  type: string
                                  example: admin@infoworks.io
                                schedule:
                                  oneOf:
                                  - type: object
                                    title: Generic Schedule
                                    description: Generic schedule object
                                    required:
                                    - schedule_status
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                        - enabled
                                        - disabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                        - NEVER
                                        - MINUTE
                                        - HOUR
                                        - DAY
                                        - WEEK
                                        - MONTH
                                        default: NEVER
                                        example: MONTH
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      repeat_on_last_day:
                                        type: boolean
                                        description: '`specified_days` must be provided if `repeat_on_last_day` is false. Applicable for `repeat_interval_unit=MONTH`

                                          '
                                        default: false
                                      specified_days:
                                        type: array
                                        description: 'Applicable when `repeat_interval_unit` is `WEEK` or `MONTH`.

                                          '
                                        minLength: 1
                                        items:
                                          type: integer
                                          minimum: 0
                                          maximum: 31
                                        example:
                                        - 1
                                        - 17
                                        - 31
                                      ends:
                                        type: boolean
                                        description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`.

                                          '
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 38
                                      is_custom_job:
                                        type: boolean
                                        description: '`custom_job_details` must be provided when `is_custom_job=true`. Applicable when `repeat_interval_unit` is `DAY`, `WEEK` or `MONTH`.

                                          '
                                        default: false
                                      custom_job_details:
                                        type: object
                                        required:
                                        - starts_daily_at
                                        - ends_daily_at
                                        - repeat_interval_measure
                                        - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                            - MINUTE
                                            - HOUR
                                  - type: object
                                    title: By Minute Schedule
                                    description: Schedule job by minutes
                                    required:
                                    - schedule_status
                                    - start_date
                                    - start_hour
                                    - start_min
                                    - repeat_interval_unit
                                    - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                        - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                        - MINUTE
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      ends:
                                        type: boolean
                                        description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`.

                                          '
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                  - type: object
                                    title: Hourly Schedule
                                    description: Schedule job hourly
                                    required:
                                    - schedule_status
                                    - start_date
                                    - start_hour
                                    - start_min
                                    - repeat_interval_unit
                                    - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                        - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                        - HOUR
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      ends:
                                        type: boolean
                                        description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`.

                                          '
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                  - type: object
                                    title: Daily Schedule
                                    description: Schedule job daily
                                    required:
                                    - schedule_status
                                    - start_date
                                    - start_hour
                                    - start_min
                                    - repeat_interval_unit
                                    - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                        - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                        - DAY
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      ends:
                                        type: boolean
                                        description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`.

                                          '
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                      is_custom_job:
                                        type: boolean
                                        description: '`custom_job_details` must be provided when `is_custom_job=true`

                                          '
                                        default: false
                                        example: true
                                      custom_job_details:
                                        type: object
                                        required:
                                        - starts_daily_at
                                        - ends_daily_at
                                        - repeat_interval_measure
                                        - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                            - MINUTE
                                            - HOUR
                                  - type: object
                                    title: Weekly Schedule
                                    description: Schedule job weekly
                                    required:
                                    - schedule_status
                                    - start_date
                                    - start_hour
                                    - start_min
                                    - repeat_interval_unit
                                    - repeat_interval_measure
                                    - specified_days
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                        - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                        - WEEK
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      specified_days:
                                        type: array
                                        minLength: 1
                                        items:
                                          type: integer
                                          minimum: 0
                                          maximum: 6
                                        example:
                                        - 0
                                        - 2
                                        - 5
                                      ends:
                                        type: boolean
                                        description: '`end_date`, `end_hour`, `end_min` must be provided if `ends` is `true`.

                                          '
                                        default: false
                                        example: true
                                      end_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: End time should be after start time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      end_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 15
                                      end_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 55
                                      is_custom_job:
                                        type: boolean
                                        description: '`custom_job_details` must be provided when `is_custom_job=true`

                                          '
                                        default: false
                                        example: true
                                      custom_job_details:
                                        type: object
                                        required:
                                        - starts_daily_at
                                        - ends_daily_at
                                        - repeat_interval_measure
                                        - repeat_interval_unit
                                        properties:
                                          starts_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '12:40'
                                          ends_daily_at:
                                            pattern: ^{0-23}:[0-59]$
                                            type: string
                                            example: '17:45'
                                          repeat_interval_measure:
                                            type: integer
                                            minimum: 1
                                            example: 10
                                          repeat_interval_unit:
                                            type: string
                                            enum:
                                            - MINUTE
                                            - HOUR
                                  - type: object
                                    title: Monthly Schedule
                                    description: Schedule job monthly
                                    required:
                                    - schedule_status
                                    - start_date
                                    - start_hour
                                    - start_min
                                    - repeat_interval_unit
                                    - repeat_interval_measure
                                    properties:
                                      schedule_status:
                                        type: string
                                        enum:
                                        - enabled
                                        example: enabled
                                      start_date:
                                        pattern: ^[1-12]{1}/[0-31]{1}/\d{4}$
                                        type: string
                                        description: Start time should be after current time.
                                        format: date-month'/'date-mday'/'date-fullyear
                                        example: 08/28/2023
                                      start_hour:
                                        type: integer
                                        minimum: 0
                                        maximum: 23
                                        example: 14
                                      start_min:
                                        type: integer
                                        minimum: 0
                                        maximum: 59
                                        example: 35
                                      repeat_interval_unit:
                                        type: string
                                        enum:
                                        - MONTH
                                      repeat_interval_measure:
                                        type: integer
                                        minimum: 1
                                      repeat_on_last_day:
                                        type: boolean
                                        description: '`specified_days` must be provided if `repeat_on_last_day` is false.

                                          '
                                        default: false
                                      specified_days:
                                        type: array
                                        minLength: 1
                                        items:
                                          type: integer
                                          minimum: 1
                                          maximum: 31
                                        example:
                       

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