Infoworks

Infoworks Environment API

The Environment API from Infoworks — 11 operation(s) for environment.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 17

GET /admin/environment Get the list of environments #
POST /admin/environment Create a new environment #
GET /admin/environment/{environment_id} Get the environment id details #
DELETE /admin/environment/{environment_id} Delete an Environment #
PATCH /admin/environment/{environment_id} Update an environment #
GET /admin/environment/{environment_id}/environment-storage Get the environment id storage details #
POST /admin/environment/{environment_id}/environment-storage Create storage for environment id #
GET /admin/environment/{environment_id}/environment-storage/{environment_storage_id} Get the environment storage id storage details #
GET /admin/environment/{environment_id}/environment-storage/{environment_storage_id}/pipelines Get list of pipelines using the storage #
GET /admin/environment/{environment_id}/environment-compute-template Get List of ephemeral computes for environment #
POST /admin/environment/{environment_id}/environment-compute-template Create ephemeral cluster #
GET /admin/environment/{environment_id}/environment-compute-template/{environment_compute_template_id} Get ephemeral computes for environment by id #
GET /admin/environment/{environment_id}/environment-interactive-clusters Get the list of environments interactive (persistent) templates #
POST /admin/environment/{environment_id}/environment-interactive-clusters Create an interactive compute #
GET /admin/environment/{environment_id}/environment-interactive-clusters/{environment_interactive_clusters_id} Get persistent computes for environment by id #
GET /admin/environment/{environment_id}/accessible-domains Get the accessible domains present within an environment accessible by a user #
GET /admin/environment/{environment_id}/environment-clusters Gets all environment clusters.

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-environment-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-environment-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-environment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact: {}
  title: Infoworks Rest API V3 Environment 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: Environment
  description: ''
paths:
  /admin/environment:
    get:
      security:
      - BearerAuth: []
      operationId: EnvironmentsList
      tags:
      - Environment
      summary: Get the list of environments
      description: Retrieves the list of environments that are accessible to the user.
      parameters:
      - name: fetch_all
        in: query
        description: 'Use this parameter to retrieve the list of all environments. (Only for admin user).

          '
        schema:
          type: boolean
          default: null
        required: false
      responses:
        '200':
          description: Ok.
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    message:
                      type: string
                      example: Example Success Message
                - type: object
                - properties:
                    result:
                      type: array
                      items:
                        allOf:
                        - properties:
                            platform:
                              type: string
                              example: azure
                            name:
                              type: string
                              example: sample
                        - type: object
                          properties:
                            id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                        - properties:
                            state:
                              type: string
                              example: ready
                        - 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
    post:
      security:
      - BearerAuth: []
      operationId: CreateEnvironment
      tags:
      - Environment
      summary: Create a new environment
      description: 'Creates or clones a environment.  To clone an existing environment, add the `resource_id_to_clone` query parameter. <br> **Note:** Cloning an environment will clone all its clusters and storages.

        '
      parameters:
      - name: resource_id_to_clone
        in: query
        description: 'Id of environment to be cloned.  Request body will be ignored when this parameter is passed.

          '
        schema:
          type: string
          example: 5f9708117758f33f8b013824
        required: false
      requestBody:
        content:
          multipart/form-data:
            schema:
              oneOf:
              - type: object
                properties:
                  name:
                    type: string
                    example: spark_k8s_test_1
                    pattern: ^[a-z0-9A-Z_-]+$
                  platform:
                    type: string
                    example: spark
                  compute_engine:
                    type: string
                    example: kubernetes
                  connection_configuration:
                    type: object
                    required:
                    - cluster_type
                    properties:
                      cluster_type:
                        type: string
                        enum:
                        - external
                        - internal
                        example: external
                      service_account_name:
                        type: string
                        example: kubernetes-service-account
                      authentication_mechanism:
                        type: string
                        enum:
                        - oauth_token
                        - client_key
                        example: oauth_token
                      api_url:
                        type: string
                        example: http://test.com
                      namespace:
                        type: string
                        example: kuberenetes-namespace
                      client_key:
                        type: object
                        description: Required when authentication_mechanism is client_key
                        required:
                        - upload_option
                        properties:
                          upload_option:
                            type: string
                            enum:
                            - fileUpload
                            - serverLocation
                            example: fileUpload
                          context:
                            type: string
                            example: context-value
                      oauth_details:
                        description: Required when authentication_mechanism is client_key
                        required:
                        - oauth_token
                        - https_enabled
                        properties:
                          oauth_token:
                            oneOf:
                            - type: string
                            - type: object
                              required:
                              - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                  - infoworks_managed
                                  - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                          https_enabled:
                            type: boolean
                            example: true
                          upload_option:
                            type: string
                            description: Required when https_enabled is true
                            enum:
                            - fileUpload
                            - serverLocation
                            example: fileUpload
                  files:
                    type: string
                    format: binary
                  metastore:
                    type: object
                    properties:
                      type:
                        type: string
                        example: hive
                      configuration:
                        type: object
                        required:
                        - mode
                        - connection_url
                        - metastore_db
                        - password
                        - user_name
                        properties:
                          mode:
                            type: string
                            example: external
                          metastore_db:
                            type: string
                            example: postgres
                          password:
                            oneOf:
                            - type: string
                            - type: object
                              required:
                              - password_type
                              properties:
                                password_type:
                                  type: string
                                  enum:
                                  - infoworks_managed
                                  - secret_store
                                secret_id:
                                  type: string
                                  example: e77850ad5127a2d7dab870ff
                                password:
                                  type: string
                          user_name:
                            type: string
                            example: admin
              - type: object
                properties:
                  name:
                    type: string
                    example: bigquery_gcp_databricks_test_2
                    pattern: ^[a-z0-9A-Z_-]+$
                  platform:
                    type: string
                    example: gcp
                  compute_engine:
                    type: string
                    example: databricks
                  connection_configuration:
                    type: object
                    properties:
                      workspace_url:
                        type: string
                        example: https://adb-3889563399002515.15.azuredatabricks.net
                      token:
                        oneOf:
                        - type: string
                        - type: object
                          required:
                          - password_type
                          properties:
                            password_type:
                              type: string
                              enum:
                              - infoworks_managed
                              - service_authentication
                              - secret_store
                            service_auth_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            password:
                              type: string
                      region:
                        type: string
                        example: us-east-1
                  data_warehouse_type:
                    type: string
                    example: bigQuery
                  data_warehouse_configuration:
                    type: object
                    properties:
                      type:
                        type: string
                        example: bigQuery
                      authentication_mechanism:
                        type: string
                        example: service_credential
                      service_credentials:
                        type: object
                        properties:
                          upload_option:
                            type: string
                            example: fileUpload
                      additional_params:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: key
                            value:
                              type: string
                              example: value
                  warehouse_cred_file:
                    type: string
                    format: binary
              - type: object
                properties:
                  name:
                    type: string
                    example: bigquery_gcp_dataproc_test
                    pattern: ^[a-z0-9A-Z_-]+$
                  platform:
                    type: string
                    example: gcp
                  compute_engine:
                    type: string
                    example: dataproc
                  connection_configuration:
                    type: object
                    properties:
                      authentication_mechanism:
                        type: string
                        example: system
                  data_warehouse_type:
                    type: string
                    example: bigQuery
                  data_warehouse_configuration:
                    type: object
                    properties:
                      type:
                        type: string
                        example: bigQuery
                      authntication_mechanism:
                        type: string
                        example: service_credential
                      service_credentials:
                        type: object
                        properties:
                          upload_option:
                            type: string
                            example: fileUpload
                      additional_params:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: key
                            value:
                              type: string
                              example: value
                  warehouse_cred_file:
                    type: string
                    format: binary
                  files:
                    type: string
                    format: binary
              - type: object
                properties:
                  name:
                    type: string
                    example: bigquery_test
                    pattern: ^[a-z0-9A-Z_-]+$
                  data_warehouse_type:
                    type: string
                    example: bigQuery
                  data_warehouse_configuration:
                    type: object
                    properties:
                      type:
                        type: string
                        example: bigQuery
                      authentication_mechanism:
                        type: string
                        example: service_credential
                      service_credential:
                        type: object
                        properties:
                          upload_option:
                            type: string
                            example: fileUpload
                      additional_params:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: key
                            value:
                              type: string
                              example: value
                  warehouse_cred_file:
                    type: string
                    format: binary
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  name:
                    type: string
                    example: rest_api_gcp_test_1
                    pattern: ^[a-z0-9A-Z_-]+$
                  platform:
                    type: string
                    example: gcp
                  compute_engine:
                    type: string
                    example: dataproc
                  metastore:
                    type: object
                    properties:
                      type:
                        type: string
                        example: hive
                      configuration:
                        type: object
                        properties:
                          mode:
                            type: string
                            example: external
                          admin_password_uri:
                            type: string
                            example: gs://regression50/password.encrypted
                          hive_password_uri:
                            type: string
                            example: gs://regression50/password.encrypted
                          kms_key_uri:
                            type: string
                            example: projects/iw-gcp-eng-dev/locations/global/keyRings/regression-50-keyring/cryptoKeys/regr50-key
                          warehouse_dir:
                            type: string
                            example: gs://regression50/hive-warehouse
                          use_private_ip:
                            type: boolean
                            example: true
                          machine_tag:
                            type: string
                            example: us-central1:regression50
                          runtime_version:
                            type: string
                            enum:
                            - '1.5'
                            - '2.0'
                  connection_configuration:
                    type: object
                    properties:
                      region:
                        type: string
                        example: us-central1
                      authentication_mechanism:
                        type: string
                        example: system
              - type: object
                properties:
                  name:
                    type: string
                    example: snowflake_aws_databricks_rest_1
                    pattern: ^[a-z0-9A-Z_-]+$
                  platform:
                    type: string
                    example: aws
                  compute_engine:
                    type: string
                    example: databricks
                  connection_configuration:
                    type: object
                    properties:
                      workspace_url:
                        type: string
                        example: https://adb-3889563399002515.15.azuredatabricks.net
                      token:
                        oneOf:
                        - type: string
                        - type: object
                          required:
                          - password_type
                          properties:
                            password_type:
                              type: string
                              enum:
                              - infoworks_managed
                              - service_authentication
                              - secret_store
                            service_auth_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            secret_id:
                              type: string
                              example: e77850ad5127a2d7dab870ff
                            password:
                              type: string
                      region:
                        type: string
                        example: us-east-1
                  data_warehouse_type:
                    type: string
                    example: snowflake
                  data_warehouse_configuration:
                    type: object
                    properties:
                      type:
                        type: string
                        example: snowflake
                      connection_url:
                        type: string
                        example: jdbc:mysql://host:port/hive
                      account_name:
                        type: string
                        example: test
                      snowflake_profiles:
                        type: array
                        items:
                          oneOf:
                          - type: object
                            properties:
                              name:
                                type: string
                                example: profile1
                              is_default_profile:
                                type: boolean
                                example: true
                              warehouse:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: test
                                    description:
                                      type: string
                                      example: sample description
                                    is_default_warehouse:
                                      type: boolean
                                      example: true
                              authentication_properties:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: default
                                  username:
                                    type: string
                                    example: test
                                  password:
                                    oneOf:
                                    - type: string
                                    - type: object
                                      required:
                                      - password_type
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                          - infoworks_managed
                                          - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        password:
                                          type: string
                              additional_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                              session_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                          - type: object
                            properties:
                              name:
                                type: string
                                example: profile1
                              is_default_profile:
                                type: boolean
                                example: true
                              warehouse:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: test
                                    description:
                                      type: string
                                      example: sample description
                                    is_default_warehouse:
                                      type: boolean
                                      example: true
                              authentication_properties:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    example: oauth
                                  oauth_service:
                                    type: string
                                    example: snowflake
                                  oauth_client_id:
                                    type: string
                                    example: test
                                  oauth_client_secret:
                                    oneOf:
                                    - type: string
                                    - type: object
                                      required:
                                      - password_type
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                          - infoworks_managed
                                          - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        password:
                                          type: string
                                  refresh_token:
                                    oneOf:
                                    - type: string
                                    - type: object
                                      required:
                                      - password_type
                                      properties:
                                        password_type:
                                          type: string
                                          enum:
                                          - infoworks_managed
                                          - secret_store
                                        secret_id:
                                          type: string
                                          example: e77850ad5127a2d7dab870ff
                                        password:
                                          oneOf:
                                          - type: string
                                          - type: object
                                            required:
                                            - password_type
                                            properties:
                                              password_type:
                                                type: string
                                                enum:
                                                - infoworks_managed
                                                - secret_store
                                              secret_id:
                                                type: string
                                                example: e77850ad5127a2d7dab870ff
                                              password:
                                                type: string
                              additional_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                              session_params:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    key:
                                      type: string
                                      example: key
                                    value:
                                      type: string
                                      example: value
                          - type: object
                            properties:
                              name:
                                type: string
                                example: profile1
                              is_default_profile:
                                type: boolean
                                example: true
                              warehouse:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                      example: test
                                    description:
                                      type: string
                                      example: sample description
                                    is_default_warehouse:
                                      type: boolean
                 

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