Infoworks

Infoworks Admin Configurations API

The Admin Configurations API from Infoworks — 10 operation(s) for admin configurations.

Documentation GitHub OpenAPI

Operations 13

GET /admin/configuration/general Get all General Configurations for Infoworks. #

PUT /admin/configuration/general Replace General Configurations for Infoworks. #

GET /admin/mongo-backup Gets `Mongo Backups` list. #

GET /admin/mongo-backup/{mongo_backup_id} Gets Mongo Backup With Specified Id. #

POST /admin/mongo-backup/run Start Mongo Backup #

GET /admin/mongo-backup/schedule Get the Schedule of the Mongo Backup. #

PUT /admin/mongo-backup/schedule/enable Schedule Mongo Backup. #

PUT /admin/mongo-backup/schedule/disable Schedule Mongo Backup. #

GET /admin/configuration/authentication Get the type of the Authentication and associated properties. #

PUT /admin/configuration/authentication Change the Authentication Mechanism #

PATCH /admin/configuration/authentication Change the Authentication Mechanism #

POST /admin/configuration/authentication/test-connection Test the Authentication Mechanism's Connection. #

POST /admin/configuration/authentication/test-ldap-connection Test the Authentication Connection for LDAP user. #

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-admin-configurations-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 Admin Configurations 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: Admin Configurations
paths:
  /admin/configuration/general:
    get:
      security:
      - BearerAuth: []
      operationId: getConfigs
      tags:
      - Admin Configurations
      summary: Get all General Configurations for Infoworks.
      description: Get all General Configurations for Infoworks.
      responses:
        '200':
          description: ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                  properties:
                    result:
                      type: object
                      additionalProperties:
                        properties:
                          value:
                            type: string
                            example: '1000'
                          description:
                            type: string
                            example: dummy description
        '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: putConfigs
      tags:
      - Admin Configurations
      summary: Replace General Configurations for Infoworks.
      description: Replace General Configurations for Infoworks.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                properties:
                  value:
                    type: string
                    example: '1000'
                  description:
                    type: string
                    example: dummy description
      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
  /admin/mongo-backup:
    get:
      security:
      - BearerAuth: []
      operationId: getMongoBackups
      tags:
      - Admin Configurations
      summary: Gets `Mongo Backups` list.
      description: Gets `Mongo Backups` list.
      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:
                    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: {}
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      target_path:
                        type: string
                        example: /home/ec2-user/mongo-backups
                      file_name:
                        type: string
                        example: mongo-backup-12-03-2019.zip
                      error:
                        type: string
                        example: Not Enough Space
                      status:
                        type: string
                        enum:
                        - success
                        - failed
                        - running
                      created_at:
                        type: object
                        properties:
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '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/mongo-backup/{mongo_backup_id}:
    get:
      security:
      - BearerAuth: []
      operationId: getMongoBackup
      tags:
      - Admin Configurations
      summary: Gets Mongo Backup With Specified Id.
      description: Gets Mongo Backup With Specified Id.
      parameters:
      - name: mongo_backup_id
        in: path
        required: true
        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: {}
                properties:
                  result:
                    type: object
                    properties:
                      id:
                        type: string
                        example: e77850ad5127a2d7dab870ff
                      target_path:
                        type: string
                        example: /home/ec2-user/mongo-backups
                      file_name:
                        type: string
                        example: mongo-backup-12-03-2019.zip
                      error:
                        type: string
                        example: Not Enough Space
                      status:
                        type: string
                        enum:
                        - success
                        - failed
                        - running
                      created_at:
                        type: object
                        properties:
                          created_at:
                            type: string
                            example: '2019-11-21T12:54:05.875Z'
        '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/mongo-backup/run:
    post:
      security:
      - BearerAuth: []
      operationId: startMongoBackup
      tags:
      - Admin Configurations
      summary: Start Mongo Backup
      description: Start Mongo Backup.
      responses:
        '200':
          description: Success
          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
  /admin/mongo-backup/schedule:
    get:
      security:
      - BearerAuth: []
      operationId: getBackupSchedule
      summary: Get the Schedule of the Mongo Backup.
      description: Get the Schedule of the Mongo Backup.
      tags:
      - Admin Configurations
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                properties:
                  result:
                    type: object
                    properties:
                      schedule_type:
                        type: string
                        example: mongo-backup
                      schedule_details:
                        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:
                             

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