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.
**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 example: true authentication_properties: type: object properties: type: type: string example: oauth oauth_service: type: string example: external_ad oauth_access_type: type: string enum: - user - client azure_ad_username: type: string azure_ad_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 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 username: type: string example: test oauth_scope: type: string example: test oauth_token_url: type: string example: http://test.com 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: aws_emr_rest_1 pattern: ^[a-z0-9A-Z_-]+$ platform: type: string example: aws compute_engine: type: string example: emr connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: access_key secret_key: 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 access_key: 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 metastore: type: object properties: type: type: string example: hive configuration: type: object properties: mode: type: string example: external connection_url: type: string example: jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive driver_name: type: string example: org.mariadb.jdbc.Driver user_name: type: string example: admin 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 warehouse_location: type: string example: s3://tmp-emr/warehouse13/ - type: object properties: name: type: string example: aws_emr_rest_2 pattern: ^[a-z0-9A-Z_-]+$ platform: type: string example: aws compute_engine: type: string example: emr connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: system metastore: type: object properties: type: type: string example: hive configuration: type: object properties: mode: type: string example: external connection_url: type: string example: jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive driver_name: type: string example: org.mariadb.jdbc.Driver user_name: type: string example: admin 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 warehouse_location: type: string example: s3://tmp-emr/warehouse13/ - type: object properties: name: type: string example: aws_emr_rest_3 pattern: ^[a-z0-9A-Z_-]+$ platform: type: string example: aws compute_engine: type: string example: emr connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: access_key secret_key: type: string example: tIP+bJUSEzMQv6CvCJfUGGmBLPDduGJj/D0qg9Hm access_key: type: string example: REDACTED_AWS_ACCESS_KEY_ID metastore: type: object properties: type: type: string example: glue configuration: type: object properties: mode: type: string example: external warehouse_location: type: string example: s3://tmp-emr/warehouse13/ use_custom_glue_catalog_account: type: boolean default: false glue_catalog_account_id: type: string example: '234142552452' - type: object properties: name: type: string example: aws_emr_rest_4 pattern: ^[a-z0-9A-Z_-]+$ platform: type: string example: aws compute_engine: type: string example: emr connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: system metastore: type: object properties: type: type: string example: glue configuration: type: object properties: mode: type: string example: external warehouse_location: type: string example: s3://tmp-emr/warehouse13/ use_custom_glue_catalog_account: type: boolean default: false glue_catalog_account_id: type: string example: '234142552452' - type: object properties: name: type: string example: bigquery_gcp_databricks_test_1 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-east1 data_warehouse_type: type: string example: bigQuery data_warehouse_configuration: type: object properties: type: type: string example: bigQuery authentication_mechanism: type: string example: system additional_params: type: array items: type: object properties: key: type: string example: key value: type: string example: value - 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: emr connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: access_key secret_key: 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 access_key: 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 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: 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 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: azure_databricks_rest_1 pattern: ^[a-z0-9A-Z_-]+$ platform: type: string enum: - azure - aws - gcp example: azure compute_engine: type: string example: databricks metastore: type: object properties: type: type: string example: hive configuration: type: object properties: mode: type: string example: unity_catalog 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 staging_area: type: object properties: catalog_name: type: string example: catalog_name schema_name: type: string example: schema_name volume_name: type: string example: volume_name profiles: type: array items: type: object properties: type: type: string enum: - azure_service_principal - databricks_service_principal - username name: type: string example: profile_1 username: type: string example: username databricks_service_principal: type: string example: d38bc497-94e8-4836-8bde-784fca187cbf azure_service_principal: type: object required: - password_type properties: password_type: type: string enum: - service_authentication service_auth_id: type: string example: e77850ad5127a2d7dab870ff is_default: type: boolean example: true responses: '200': description: Ok. content: application/json: schema: type: object properties: message: type: string example: Successfully created a environment. result: type: object properties: id: type: string example: 5f9708117758f33f8b013824 '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/environment/{environment_id}: parameters: - name: environment_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentsId tags: - Environment summary: Get the environment id details description: Get the environment id details responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object - properties: result: allOf: - 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 - properties: connection_configuration: properties: 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: eastus2 workspace_url: type: string example: del - properties: metastore: properties: type: type: string example: hive configuration: properties: mode: type: string example: internal '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 delete: security: - BearerAuth: [] operationId: DeleteEnvironment tags: - Environment summary: Delete an Environment description: Delete an Environment responses: '200': description: Ok. content: application/json: schema: type: object properties: message: type: string example: Environment deleted successfully result: type: object properties: id: type: string example: 5f9708117758f33f8b013824 '400': description: Request has invalid body or parameters. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10006 help: type: string example: http://api.infoworks.io/help/IW10006 '401': description: Authentication Failed. Please check your Credentials content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10005 help: type: string example: http://api.infoworks.io/help/IW10005 '403': description: Forbidden. User lacks access to specified resource. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10004 help: type: string example: http://api.infoworks.io/help/IW10004 '500': description: Internal Server Error. content: application/json: schema: type: object allOf: - type: object properties: message: type: string example: Something went wrong details: type: object properties: {} - type: object properties: iw_code: type: string example: IW10002 help: type: string example: http://api.infoworks.io/help/IW10002 patch: security: - BearerAuth: [] operationId: UpdateEnvironment tags: - Environment summary: Update an environment description: Update an existing environment requestBody: content: multipart/form-data: schema: oneOf: - type: object properties: name: type: string example: spark_k8s_test_1 pattern: ^[a-z0-9A-Z_-]+$ connection_configuration: type: object properties: 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: configuration: type: object properties: 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_-]+$ 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_configuration: type: object properties: 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_-]+$ connection_configuration: type: object properties: authentication_mechanism: type: string example: system data_warehouse_configuration: type: object properties: 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_configuration: type: object properties: 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_-]+$ metastore: type: object properties: configuration: type: object properties: 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 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_-]+$ 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_configuration: type: object properties: 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 example: true authentication_properties: type: object properties: type: type: string example: oauth oauth_service: type: string example: external_ad oauth_access_type: type: string enum: - user - client azure_ad_username: type: string azure_ad_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 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 username: type: string example: test oauth_scope: type: string example: test oauth_token_url: type: string example: http://test.com 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: aws_emr_rest_1 pattern: ^[a-z0-9A-Z_-]+$ connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: access_key secret_key: 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 access_key: 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 metastore: type: object properties: configuration: type: object properties: connection_url: type: string example: jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive driver_name: type: string example: org.mariadb.jdbc.Driver user_name: type: string example: admin 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 warehouse_location: type: string example: s3://tmp-emr/warehouse13/ - type: object properties: name: type: string example: aws_emr_rest_2 pattern: ^[a-z0-9A-Z_-]+$ connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: system metastore: type: object properties: configuration: type: object properties: connection_url: type: string example: jdbc:mysql://emr-regression-500.cjkihlti48zz.us-east-1.rds.amazonaws.com:3306/hive driver_name: type: string example: org.mariadb.jdbc.Driver user_name: type: string example: admin 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 warehouse_location: type: string example: s3://tmp-emr/warehouse13/ - type: object properties: name: type: string example: aws_emr_rest_3 pattern: ^[a-z0-9A-Z_-]+$ connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: access_key secret_key: type: string example: tIP+bJUSEzMQv6CvCJfUGGmBLPDduGJj/D0qg9Hm access_key: type: string example: REDACTED_AWS_ACCESS_KEY_ID metastore: type: object properties: configuration: type: object properties: warehouse_location: type: string example: s3://tmp-emr/warehouse13/ use_custom_glue_catalog_account: type: boolean default: false glue_catalog_account_id: type: string example: '234142552452' - type: object properties: name: type: string example: aws_emr_rest_4 pattern: ^[a-z0-9A-Z_-]+$ connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: system metastore: type: object properties: configuration: type: object properties: warehouse_location: type: string example: s3://tmp-emr/warehouse13/ use_custom_glue_catalog_account: type: boolean default: false glue_catalog_account_id: type: string example: '234142552452' - type: object properties: name: type: string example: bigquery_gcp_databricks_test_1 pattern: ^[a-z0-9A-Z_-]+$ 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-east1 data_warehouse_configuration: type: object properties: authentication_mechanism: type: string example: system additional_params: type: array items: type: object properties: key: type: string example: key value: type: string example: value - type: object properties: name: type: string example: snowflake_aws_databricks_rest_1 pattern: ^[a-z0-9A-Z_-]+$ connection_configuration: type: object properties: region: type: string example: us-east-1 authentication_mechanism: type: string example: access_key secret_key: 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 access_key: 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 data_warehouse_configuration: type: object properties: connection_url: type: string example: jdbc:mysql://host:port/hive account_name: type: string example: test snowflake_profiles: type: array items: 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 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: azure_databricks_rest_1 pattern: ^[a-z0-9A-Z_-]+$ platform: type: string enum: - azure - aws - gcp example: azure compute_engine: type: string example: databricks metastore: type: object properties: type: type: string example: hive configuration: type: object properties: mode: type: string example: unity_catalog 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 staging_area: type: object properties: catalog_name: type: string example: catalog_name schema_name: type: string example: schema_name volume_name: type: string example: volume_name profiles: type: array items: type: object properties: type: type: string enum: - azure_service_principal - databricks_service_principal - username name: type: string example: profile_1 username: type: string example: username databricks_service_principal: type: string example: d38bc497-94e8-4836-8bde-784fca187cbf azure_service_principal: type: object required: - password_type properties: password_type: type: string enum: - service_authentication service_auth_id: type: string example: e77850ad5127a2d7dab870ff is_default: type: boolean example: true responses: '200': description: Ok. content: application/json: schema: type: object properties: message: type: string example: Environment updated successfully '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/environment/{environment_id}/environment-storage: parameters: - name: environment_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentsIdStorage tags: - Environment summary: Get the environment id storage details description: Get the environment id storage details responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object - properties: result: type: array items: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff storage_type: type: string example: dbfs name: type: string example: del storage_authentication: properties: db_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 db_url: type: string '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: EnvironmentStorage tags: - Environment summary: Create storage for environment id description: Create storage for environment id requestBody: content: multipart/form-data: schema: oneOf: - type: object properties: name: type: string example: gcs_test_5 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' region: type: string example: us-east1 storage_type: type: string example: gcs storage_authentication: type: object properties: scheme: type: string example: gs:// bucket_name: type: string example: staging-bucket-xxx authentication_mechanism: type: string example: service_credential service_credentials: type: object properties: upload_option: type: string example: fileUpload is_default_storage: type: boolean example: true files: type: string format: binary - type: object properties: name: type: string example: gcs_test5 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' storage_type: type: string example: gcs storage_authentication: type: object properties: scheme: type: string example: gs:// bucket_name: type: string example: staging-bucket-xxx authentication_mechanism: type: string example: service_credential service_credentials: type: object properties: upload_option: type: string example: fileUpload is_default_storage: type: boolean example: true files: type: string format: binary application/json: schema: oneOf: - type: object properties: name: type: string example: gcs_test3 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' region: type: string example: us-east1 storage_type: type: string example: gcs storage_authentication: type: object properties: scheme: type: string example: gs:// bucket_name: type: string example: staging-bucket-xxx authentication_mechanism: type: string example: system is_default_storage: type: boolean example: true - type: object properties: name: type: string example: gcs_test6 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' region: type: string example: us-east1 storage_type: type: string example: gcs storage_authentication: type: object properties: scheme: type: string example: gs:// bucket_name: type: string example: staging-bucket-xxx authentication_mechanism: type: string example: environment_service_credential is_default_storage: type: boolean example: true - type: object properties: name: type: string example: gcs_test4 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' storage_type: type: string example: gcs storage_authentication: type: object properties: scheme: type: string example: gs:// bucket_name: type: string example: staging-bucket-xxx authentication_mechanism: type: string example: system is_default_storage: type: boolean example: true - type: object properties: name: type: string example: gcs_test6 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' storage_type: type: string example: gcs storage_authentication: type: object properties: scheme: type: string example: gs:// bucket_name: type: string example: staging-bucket-xxx authentication_mechanism: type: string example: system storage_integration_name: type: string example: test is_default_storage: type: boolean example: true - type: object properties: name: type: string example: dbfs3 pattern: ^[a-z0-9A-Z_-]+$ description: type: string example: '' storage_type: type: string example: dbfs is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' name: type: string example: adls_gen1_1 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: adls_gen1 storage_authentication: type: object properties: scheme: type: string example: adl:// authentication_mechanism: type: string example: service_principal storage_account_name: type: string example: ingestionadlsgen1 application_id: type: string example: test directory_id: type: string example: test service_credential: oneOf: - type: object required: - password_type properties: password_type: type: string enum: - service_authentication service_auth_id: type: string example: e77850ad5127a2d7dab870ff is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' name: type: string example: adls_gen1_2 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: adls_gen1 storage_authentication: type: object properties: scheme: type: string example: adl:// authentication_mechanism: type: string example: service_principal storage_account_name: type: string example: ingestionadlsgen1 application_id: type: string example: test directory_id: type: string example: test service_credential: oneOf: - type: object required: - password_type properties: password_type: type: string enum: - service_authentication service_auth_id: type: string example: e77850ad5127a2d7dab870ff storage_integration_name: type: string example: '' is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' name: type: string example: adls_gen2_1 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: adls_gen2 storage_authentication: type: object properties: scheme: type: string example: abfss:// authentication_mechanism: type: string example: access_key file_system: type: string example: ingestion storage_account_name: type: string example: ingestionadlsgen2 access_key_name: 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 - type: object properties: description: type: string example: '' name: type: string example: adls_gen2_2 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: adls_gen2 storage_authentication: type: object properties: scheme: type: string example: abfs:// authentication_mechanism: type: string example: service_principal file_system: type: string example: ingestion storage_account_name: type: string example: ingestionadlsgen2 application_id: type: string example: tesst directory_id: type: string example: test service_credential: oneOf: - type: object required: - password_type properties: password_type: type: string enum: - service_authentication service_auth_id: type: string example: e77850ad5127a2d7dab870ff - type: object properties: description: type: string example: '' name: type: string example: adls_gen2_3 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: adls_gen2 storage_authentication: type: object properties: scheme: type: string example: abfss:// authentication_mechanism: type: string example: access_key file_system: type: string example: ingestion storage_account_name: type: string example: ingestionadlsgen2 access_key_name: 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 storage_integration_name: type: string example: '' - type: object properties: description: type: string example: '' name: type: string example: adls_gen2_4 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: adls_gen2 storage_authentication: type: object properties: scheme: type: string example: abfs:// authentication_mechanism: type: string example: service_principal file_system: type: string example: ingestion storage_account_name: type: string example: ingestionadlsgen2 application_id: type: string example: tesst directory_id: type: string example: test service_credential: oneOf: - type: object required: - password_type properties: password_type: type: string enum: - service_authentication service_auth_id: type: string example: e77850ad5127a2d7dab870ff storage_integration_name: type: string example: '' - type: object properties: description: type: string example: '' name: type: string example: wasb_1 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: wasb storage_authentication: type: object properties: scheme: type: string example: wasb:// container_name: type: string example: test storage_account_name: type: string example: test account_key: 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 - type: object properties: description: type: string example: '' name: type: string example: wasb_2 pattern: ^[a-z0-9A-Z_-]+$ storage_type: type: string example: wasb storage_authentication: type: object properties: scheme: type: string example: wasb:// container_name: type: string example: test storage_account_name: type: string example: test account_key: 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 storage_integration_name: type: string example: '' - type: object properties: description: type: string example: '' storage_type: type: string example: s3 name: type: string example: s3_1 pattern: ^[a-z0-9A-Z_-]+$ storage_authentication: type: object properties: scheme: type: string example: s3a:// bucket_name: type: string example: tmp-databricks secret_key: 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 access_key: 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 is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' storage_type: type: string example: s3 name: type: string example: s3_2 pattern: ^[a-z0-9A-Z_-]+$ region: type: string example: us-east-1 storage_authentication: type: object properties: authentication_mechanism: type: string example: environment_access_key scheme: type: string example: s3:// bucket_name: type: string example: tmp-emr is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' storage_type: type: string example: s3 name: type: string example: s3_3 pattern: ^[a-z0-9A-Z_-]+$ region: type: string example: us-east-1 storage_authentication: type: object properties: authentication_mechanism: type: string example: system scheme: type: string example: s3:// bucket_name: type: string example: tmp-emr is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' storage_type: type: string example: s3 name: type: string example: s3_4 pattern: ^[a-z0-9A-Z_-]+$ region: type: string example: us-east-1 storage_authentication: type: object properties: authentication_mechanism: type: string example: access_key scheme: type: string example: s3:// bucket_name: type: string example: tmp-emr access_key: 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 secret_key: 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 is_default_storage: type: boolean example: true - type: object properties: description: type: string example: '' storage_type: type: string example: s3 name: type: string example: s3_5 pattern: ^[a-z0-9A-Z_-]+$ storage_authentication: type: object properties: scheme: type: string example: s3a:// bucket_name: type: string example: tmp-databricks secret_key: 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 access_key: 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 storage_integration_name: type: string example: test is_default_storage: type: boolean example: true responses: '200': description: Ok. content: application/json: schema: type: object properties: message: type: string example: Successfully created a environment storage. result: type: object properties: id: type: string example: 5f9708117758f33f8b013824 '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/environment/{environment_id}/environment-storage/{environment_storage_id}: parameters: - name: environment_id in: path required: true schema: type: string - name: environment_storage_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentsIdStorageId tags: - Environment summary: Get the environment storage id storage details description: Get the environment storage id storage details 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 allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff storage_type: type: string example: dbfs name: type: string example: del storage_authentication: properties: db_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 db_url: type: string '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/environment/{environment_id}/environment-storage/{environment_storage_id}/pipelines: parameters: - name: environment_id in: path required: true schema: type: string - name: environment_storage_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentsIdStorageIdPipelines tags: - Environment summary: Get list of pipelines using the storage description: Get list of pipelines using the storage responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object - properties: result: type: array items: properties: id: type: string example: c8ff2b391e24ec60143b2d3c name: type: string example: testPipeline '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/environment/{environment_id}/environment-compute-template: parameters: - name: environment_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentsComputeTemplate tags: - Environment summary: Get List of ephemeral computes for environment description: Get List of ephemeral computes for environment responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object - properties: result: type: array items: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: id: type: string example: e77850ad5127a2d7dab870ff description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff name: type: string example: del compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral - properties: compute_configuration: properties: runtime_configuration: allOf: - properties: cluster_mode: type: string example: standard engine_type: type: string example: spark max_allowed_workers: type: integer example: 2 idle_termination_timeout: type: integer example: 120 worker_node_type: type: string example: Standard_NC24 driver_node_type: type: string example: Standard_NC24 runtime_version_properties: type: object properties: runtime_version: type: string example: 9.1 - properties: num_worker_node: type: integer example: 2 enable_autoscale: type: boolean example: false connection_configuration: properties: region: type: string example: eastus2 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 workspace_url: type: string example: standard '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: CreateEnvironmentsComputeTemplate tags: - Environment summary: Create ephemeral cluster description: Create ephemeral cluster requestBody: content: application/json: schema: oneOf: - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: emr launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket_name: type: string example: tmp-emr cluster_subnet_id: type: string example: subnet-060f04d20161fdc50 cluster_vpc: type: string example: vpc-09c1213e9c26d87bf ssh_key: type: string example: dev driver_node_type: type: string example: m4.large runtime_version: type: string example: 5.32.0 allow_zero_workers: type: boolean example: true enable_security_configuration: type: boolean example: true security_configuration: type: object properties: enable_kerberos: type: boolean example: true security_configuration_name: type: string example: emr-kerberos-dedicated kerberos: type: object properties: realm: type: string example: infoworks.io kdc_admin_password: type: string example: IN11**rk connection_configuration: type: object properties: region: type: string example: us-east-1 - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: emr launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket_name: type: string example: tmp-emr cluster_subnet_id: type: string example: subnet-060f04d20161fdc50 cluster_vpc: type: string example: vpc-09c1213e9c26d87bf ssh_key: type: string example: dev driver_node_type: type: string example: m4.large runtime_version: type: string example: 5.32.0 allow_zero_workers: type: boolean example: true enable_security_configuration: type: boolean example: true security_configuration: type: object properties: enable_kerberos: type: boolean example: true security_configuration_name: type: string example: emr-kerberos-dedicated kerberos: type: object properties: realm: type: string example: infoworks.io kdc_admin_password: type: string example: IN11**rk use_custom_instance_role: type: boolean example: true instance_account: type: string example: EMR_EC2_Default_Role connection_configuration: type: object properties: region: type: string example: us-east-1 - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: emr launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket_name: type: string example: tmp-emr cluster_subnet_id: type: string example: subnet-060f04d20161fdc50 cluster_vpc: type: string example: vpc-09c1213e9c26d87bf ssh_key: type: string example: dev max_allowed_workers: type: integer example: 5 num_worker_nodes: type: integer example: 4 worker_node_type: type: string example: m4.large driver_node_type: type: string example: m4.large runtime_version: type: string example: 5.32.0 enable_security_configuration: type: boolean example: true security_configuration: type: object properties: enable_kerberos: type: boolean example: true security_configuration_name: type: string example: emr-kerberos-dedicated kerberos: type: object properties: realm: type: string example: infoworks.io kdc_admin_password: type: string example: IN11**rk connection_configuration: type: object properties: region: type: string example: us-east-1 - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 worker_node_type: type: string example: n2-standard-4 driver_node_type: type: string example: n2-standard-4 num_worker_nodes: type: integer example: 4 max_allowed_workers: type: integer example: 6 runtime_version: type: string example: '1.5' connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark runtime_version: type: string example: '1.5' staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 driver_node_type: type: string example: n2-standard-4 allow_zero_workers: type: boolean example: true connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: '' - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark runtime_version: type: string example: '1.5' staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 driver_node_type: type: string example: n2-standard-4 allow_zero_workers: type: boolean example: true use_custom_service_account: type: boolean example: true service_account: type: string example: test connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: '' - type: object properties: description: type: string example: '' name: type: string example: gcp_datapproc_single_node1 pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark runtime_version: type: string example: '1.5' staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 driver_node_type: type: string example: n2-standard-4 allow_zero_workers: type: boolean example: true advanced_configurations: type: object properties: is_active: type: boolean example: true key: type: string example: test value: type: string example: test_value connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: test - type: object properties: description: type: string example: '' name: type: string example: gcp_datapproc_multi_node2 pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 worker_node_type: type: string example: n2-standard-4 driver_node_type: type: string example: n2-standard-4 max_allowed_workers: type: integer example: 6 runtime_version: type: string example: '1.5' allow_zero_workers: type: boolean example: false enable_autoscale: type: boolean example: true autoscale: type: object properties: min_worker_nodes: type: integer example: 2 max_worker_nodes: type: integer example: 5 num_master_local_ssds: type: integer minimum: 0 example: 1 description: 'Number of Local SSDs for master node. Check https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for allowed values. ' master_local_ssd_interface: type: integer minimum: 0 example: 1 description: 'Disk interface of Local SSD for master node. Check https://cloud.google.com/compute/docs/disks/local-ssd#choose_an_interface for more info. ' num_worker_local_ssds: type: integer minimum: 0 example: 1 description: 'Number of Local SSDs for worker node. Check https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for allowed values. ' worker_local_ssd_interface: type: integer minimum: 0 example: 1 description: 'Disk interface of Local SSD for worker node. Check https://cloud.google.com/compute/docs/disks/local-ssd#choose_an_interface for more info. ' enable_secondary_worker: type: boolean example: true secondary_worker_config: type: object properties: secondary_worker_type: type: integer example: 2 min_secondary_worker_nodes: type: integer example: 2 max_secondary_worker_nodes: type: integer example: 3 secondary_node_type: type: string example: n1-standard-4 advanced_configurations: type: object properties: is_active: type: boolean example: true key: type: string example: test value: type: string example: test_value connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: - type: object properties: description: type: string example: '' name: type: string example: gcp_databricks_multi_node_with_autoscale1 pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark worker_node_type: type: string example: n2-standard-4 driver_node_type: type: string example: n2-standard-4 max_allowed_workers: type: integer example: 6 runtime_version: type: string example: '7.3' enable_autoscale: type: boolean example: true autoscale: type: object properties: min_worker_nodes: type: integer example: 2 max_worker_nodes: type: integer example: 5 enable_secondary_worker: type: boolean example: true secondary_worker_config: type: object properties: secondary_worker_type: type: integer example: 2 min_secondary_worker_nodes: type: integer example: 2 max_secondary_worker_nodes: type: integer example: 3 secondary_node_type: type: string example: n1-standard-4 advanced_configurations: type: object properties: is_active: type: boolean example: true key: type: string example: test value: type: string example: test_value ml_workflow_supported: type: boolean example: true - type: object properties: description: type: string example: '' name: type: string example: gcp_databricks_multi_node_with_autoscale1 pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark driver_node_type: type: string example: n2-standard-4 runtime_version: type: string example: '7.3' allow_zero_workers: type: boolean example: true ml_workflow_supported: type: boolean example: true - type: object properties: description: type: string example: '' name: type: string example: databricks_unity_with_autoscale1 pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark worker_node_type: type: string example: n2-standard-4 driver_node_type: type: string example: n2-standard-4 max_allowed_workers: type: integer example: 6 runtime_version: type: string example: '14.3' enable_autoscale: type: boolean example: true autoscale: type: object properties: min_worker_nodes: type: integer example: 2 max_worker_nodes: type: integer example: 5 enable_secondary_worker: type: boolean example: true secondary_worker_config: type: object properties: secondary_worker_type: type: integer example: 2 min_secondary_worker_nodes: type: integer example: 2 max_secondary_worker_nodes: type: integer example: 3 secondary_node_type: type: string example: n1-standard-4 advanced_configurations: type: object properties: is_active: type: boolean example: true key: type: string example: test value: type: string example: test_value ml_workflow_supported: type: boolean example: true data_security_mode: type: string enum: - SINGLE_USER - USER_ISOLATION example: USER_ISOLATION policy_id: type: string example: responses: '200': description: Ok. content: application/json: schema: type: object properties: message: type: string example: Successfully created a environment compute. result: type: object properties: id: type: string example: 5f9708117758f33f8b013824 '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/environment/{environment_id}/environment-compute-template/{environment_compute_template_id}: parameters: - name: environment_id in: path required: true schema: type: string - name: environment_compute_template_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentsComputeTemplateId tags: - Environment summary: Get ephemeral computes for environment by id description: Get ephemeral computes for environment by id 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 allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: id: type: string example: e77850ad5127a2d7dab870ff description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff name: type: string example: del compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral - properties: compute_configuration: properties: runtime_configuration: allOf: - properties: cluster_mode: type: string example: standard engine_type: type: string example: spark max_allowed_workers: type: integer example: 2 idle_termination_timeout: type: integer example: 120 worker_node_type: type: string example: Standard_NC24 driver_node_type: type: string example: Standard_NC24 runtime_version_properties: type: object properties: runtime_version: type: string example: 9.1 - properties: num_worker_node: type: integer example: 2 enable_autoscale: type: boolean example: false connection_configuration: properties: region: type: string example: eastus2 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 workspace_url: type: string example: standard '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/environment/{environment_id}/environment-interactive-clusters: parameters: - name: environment_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentInteractiveId tags: - Environment summary: Get the list of environments interactive (persistent) templates description: Get the list of environments interactive (persistent) templates responses: '200': description: Ok. content: application/json: schema: allOf: - type: object properties: limit: type: integer example: 10 offset: type: integer example: 0 links: type: object properties: base: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains} self: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=0 next: type: string format: uri example: https://localhost:3001/v3/{admin/{workflows/{| |runs|tasks}|cluster-templates|jobs|admin-jobs|users}|sources|pipelines|cubes|domains}?limit=10&offset=10 total_count: type: integer example: 10 x-examples: example-1: {} - type: object properties: message: type: string example: Example Success Message - type: object - properties: result: type: array items: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: id: type: string example: e77850ad5127a2d7dab870ff description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff name: type: string example: del compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral - properties: compute_configuration: properties: runtime_configuration: allOf: - properties: cluster_mode: type: string example: standard engine_type: type: string example: spark max_allowed_workers: type: integer example: 2 idle_termination_timeout: type: integer example: 120 worker_node_type: type: string example: Standard_NC24 driver_node_type: type: string example: Standard_NC24 runtime_version_properties: type: object properties: runtime_version: type: string example: 9.1 connection_configuration: properties: region: type: string example: eastus2 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 workspace_url: type: string example: standard '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: EnvironmentInteractive tags: - Environment summary: Create an interactive compute description: Create an interactive compute requestBody: content: application/json: schema: oneOf: - type: object properties: description: type: string example: '' name: type: string example: spark_kubernetes_interactive pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: kubernetesInteractive launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: cluster_type: type: string example: external staging_bucket: type: string example: staging-bucket engine_type: type: string example: spark runtime_version_properties: type: object properties: label: type: string example: Beta python: type: string example: '3.8' scala: type: string example: '2.12' spark: type: string example: 3.x runtime_version: type: string example: Spark-3.3.2-scala2.12 advanced_configurations: type: object properties: is_active: type: boolean example: true key: type: string example: test value: type: string example: test_value - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: emr launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket_name: type: string example: tmp-emr cluster_subnet_id: type: string example: subnet-060f04d20161fdc50 cluster_vpc: type: string example: vpc-09c1213e9c26d87bf ssh_key: type: string example: dev driver_node_type: type: string example: m4.large runtime_version: type: string example: 5.32.0 idle_termination_timeout: type: integer example: 120 allow_zero_workers: type: boolean example: true enable_security_configuration: type: boolean example: true security_configuration: type: object properties: enable_kerberos: type: boolean example: true security_configuration_name: type: string example: emr-kerberos-dedicated kerberos: type: object properties: realm: type: string example: infoworks.io kdc_admin_password: type: string example: IN11**rk connection_configuration: type: object properties: region: type: string example: us-east-1 - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: emr launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket_name: type: string example: tmp-emr cluster_subnet_id: type: string example: subnet-060f04d20161fdc50 cluster_vpc: type: string example: vpc-09c1213e9c26d87bf ssh_key: type: string example: dev driver_node_type: type: string example: m4.large runtime_version: type: string example: 5.32.0 idle_termination_timeout: type: integer example: 120 allow_zero_workers: type: boolean example: true enable_security_configuration: type: boolean example: true security_configuration: type: object properties: enable_kerberos: type: boolean example: true security_configuration_name: type: string example: emr-kerberos-dedicated kerberos: type: object properties: realm: type: string example: infoworks.io kdc_admin_password: type: string example: IN11**rk use_custom_instance_role: type: boolean example: true instance_account: type: string example: EMR_EC2_Default_Role connection_configuration: type: object properties: region: type: string example: us-east-1 - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: emr launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket_name: type: string example: tmp-emr cluster_subnet_id: type: string example: subnet-060f04d20161fdc50 cluster_vpc: type: string example: vpc-09c1213e9c26d87bf ssh_key: type: string example: dev max_allowed_workers: type: integer example: 5 num_worker_nodes: type: integer example: 4 worker_node_type: type: string example: m4.large driver_node_type: type: string example: m4.large runtime_version: type: string example: 5.32.0 idle_termination_timeout: type: integer example: 120 enable_security_configuration: type: boolean example: true security_configuration: type: object properties: enable_kerberos: type: boolean example: true security_configuration_name: type: string example: emr-kerberos-dedicated kerberos: type: object properties: realm: type: string example: infoworks.io kdc_admin_password: type: string example: IN11**rk connection_configuration: type: object properties: region: type: string example: us-east-1 - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 worker_node_type: type: string example: n2-standard-4 driver_node_type: type: string example: n2-standard-4 num_worker_nodes: type: integer example: 4 max_allowed_workers: type: integer example: 6 runtime_version: type: string example: '1.5' idle_termination_timeout: type: integer example: 120 connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_%%templ%% pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataproc launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark runtime_version: type: string example: '1.5' staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 driver_node_type: type: string example: n2-standard-4 allow_zero_workers: type: boolean example: true idle_termination_timeout: type: integer example: 120 connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: '' - type: object properties: description: type: string example: '' name: type: string example: custom_regression_template_restapi_test pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: dataprocInteractive launch_strategy: type: string example: persistent compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark runtime_version: type: string example: '1.5' staging_bucket: type: string example: gs://staging-bucket-xxx temp_bucket: type: string example: gs://temp-bucket-xxx cluster_subnetwork: type: string example: https://www.googleapis.com/compute/v1/projects/iw-gcp-eng-host/regions/us-central1/subnetworks/gcp-eng-host-vpc-1-subnet-2 driver_node_type: type: string example: n2-standard-4 allow_zero_workers: type: boolean example: true idle_termination_timeout: type: integer example: 120 connection_configuration: type: object properties: region: type: string example: us-central1 project_id: type: string example: test - type: object properties: description: type: string example: '' name: type: string example: databricks_unity_with_autoscale1 pattern: ^[a-z0-9A-Z_-]+$ compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral compute_configuration: type: object properties: runtime_configuration: type: object properties: engine_type: type: string example: spark worker_node_type: type: string example: n2-standard-4 driver_node_type: type: string example: n2-standard-4 max_allowed_workers: type: integer example: 6 runtime_version: type: string example: '14.3' enable_autoscale: type: boolean example: true autoscale: type: object properties: min_worker_nodes: type: integer example: 2 max_worker_nodes: type: integer example: 5 enable_secondary_worker: type: boolean example: true secondary_worker_config: type: object properties: secondary_worker_type: type: integer example: 2 min_secondary_worker_nodes: type: integer example: 2 max_secondary_worker_nodes: type: integer example: 3 secondary_node_type: type: string example: n1-standard-4 advanced_configurations: type: object properties: is_active: type: boolean example: true key: type: string example: test value: type: string example: test_value ml_workflow_supported: type: boolean example: true data_security_mode: type: string enum: - SINGLE_USER - USER_ISOLATION example: USER_ISOLATION policy_id: type: string example: responses: '200': description: Ok. content: application/json: schema: type: object properties: message: type: string example: Successfully created a environment compute. result: type: object properties: id: type: string example: 5f9708117758f33f8b013824 '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/environment/{environment_id}/environment-interactive-clusters/{environment_interactive_clusters_id}: parameters: - name: environment_id in: path required: true schema: type: string - name: environment_interactive_clusters_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentInteractiveClusterId tags: - Environment summary: Get persistent computes for environment by id description: Get persistent computes for environment by id 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 allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: id: type: string example: e77850ad5127a2d7dab870ff description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff name: type: string example: del compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral - properties: compute_configuration: properties: runtime_configuration: allOf: - properties: cluster_mode: type: string example: standard engine_type: type: string example: spark max_allowed_workers: type: integer example: 2 idle_termination_timeout: type: integer example: 120 worker_node_type: type: string example: Standard_NC24 driver_node_type: type: string example: Standard_NC24 runtime_version_properties: type: object properties: runtime_version: type: string example: 9.1 connection_configuration: properties: region: type: string example: eastus2 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 workspace_url: type: string example: standard '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/environment/{environment_id}/accessible-domains: parameters: - name: environment_id in: path required: true schema: type: string get: security: - BearerAuth: [] operationId: EnvironmentAccessibleDomains tags: - Environment summary: Get the accessible domains present within an environment accessible by a user description: Get the accessible domains present within an environment accessible by a user 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 properties: id: type: string example: 1774ec9fc0c66e9823c2e58a name: type: string example: Domain Name '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/environment/{environment_id}/environment-clusters: parameters: - name: environment_id in: path required: true schema: type: string get: security: - BearerAuth: [] tags: - Environment summary: Gets all environment clusters. description: Gets all environment clusters. responses: '200': description: Success content: application/json: schema: allOf: - type: object properties: message: type: string example: Example Success Message - type: object properties: result: type: array items: allOf: - type: object properties: id: type: string example: e77850ad5127a2d7dab870ff - properties: id: type: string example: e77850ad5127a2d7dab870ff description: type: string environment_id: type: string example: e77850ad5127a2d7dab870ff name: type: string example: del compute_engine: type: string example: databricks launch_strategy: type: string example: ephemeral - properties: compute_configuration: properties: runtime_configuration: allOf: - properties: cluster_mode: type: string example: standard engine_type: type: string example: spark max_allowed_workers: type: integer example: 2 idle_termination_timeout: type: integer example: 120 worker_node_type: type: string example: Standard_NC24 driver_node_type: type: string example: Standard_NC24 runtime_version_properties: type: object properties: runtime_version: type: string example: 9.1 connection_configuration: properties: region: type: string example: eastus2 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 workspace_url: type: string example: standard '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 components: securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT BasicAuth: type: http scheme: basic