Infoworks Environment Cluster API
Environment Cluster to start/stop/restart cluster
Operations 7
GET
/admin/environment/cluster/compute-template/{compute_template_id}
Get Persistent Cluster Status
#
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/infoworks:infoworks-environment-cluster-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
title: Infoworks Rest API V3 Environment Cluster 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 Cluster
description: Environment Cluster to start/stop/restart cluster
paths:
/admin/environment/cluster/compute-template/{compute_template_id}:
parameters:
- name: compute_template_id
in: path
required: true
schema:
type: string
get:
security:
- BearerAuth: []
tags:
- Environment Cluster
parameters:
- name: offset
in: query
description: The number of items to skip before starting to collect the result set
schema:
type: integer
default: 0
- name: limit
in: query
description: The numbers of items to return
schema:
type: integer
default: 10
- name: sort_by
in: query
description: Sort result on field
schema:
type: string
- name: order_by
in: query
description: order ascending | descending
schema:
type: string
default: asc
enum:
- asc
- desc
- name: filter
in: query
description: Filter results query
schema:
type: string
summary: Get Persistent Cluster Status
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
operationId: getAdminEnvironmentClusterComputeTemplateByComputeTemplateId
x-operation-id-source: derived
/admin/environment/cluster/{environment_id}:
parameters:
- name: environment_id
in: path
required: true
schema:
type: string
get:
security:
- BearerAuth: []
tags:
- Environment Cluster
parameters:
- name: offset
in: query
description: The number of items to skip before starting to collect the result set
schema:
type: integer
default: 0
- name: limit
in: query
description: The numbers of items to return
schema:
type: integer
default: 10
- name: sort_by
in: query
description: Sort result on field
schema:
type: string
- name: order_by
in: query
description: order ascending | descending
schema:
type: string
default: asc
enum:
- asc
- desc
- name: filter
in: query
description: Filter results query
schema:
type: string
summary: Get Environment Status
responses:
'200':
description: Ok.
content:
application/json:
schema:
oneOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
operationId: getAdminEnvironmentClusterByEnvironmentId
x-operation-id-source: derived
/admin/environment/cluster/service/stop:
post:
security:
- BearerAuth: []
operationId: persistentClusterStop
tags:
- Environment Cluster
summary: Stop the persistent cluster
requestBody:
content:
application/json:
schema:
allOf:
- type: object
properties:
compute_template_id:
type: string
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
x-operation-id-source: normalized
x-operation-id-original: persistent cluster stop
/admin/environment/cluster/terminate-async:
put:
security:
- BearerAuth: []
operationId: terminateStop
tags:
- Environment Cluster
summary: Terminate the persistent cluster
requestBody:
content:
application/json:
schema:
allOf:
- type: object
properties:
compute_template_id:
type: string
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
x-operation-id-source: normalized
x-operation-id-original: terminate stop
/admin/environment/cluster/restart:
put:
security:
- BearerAuth: []
operationId: clusterRestart
tags:
- Environment Cluster
summary: Restart the cluster
requestBody:
content:
application/json:
schema:
allOf:
- type: object
properties:
compute_template_id:
type: string
type:
type: string
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
x-operation-id-source: normalized
x-operation-id-original: cluster restart
/admin/environment/cluster/stop:
put:
security:
- BearerAuth: []
operationId: clusterStop
tags:
- Environment Cluster
summary: Stop the cluster
requestBody:
content:
application/json:
schema:
allOf:
- type: object
properties:
compute_template_id:
type: string
type:
type: string
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
x-operation-id-source: normalized
x-operation-id-original: cluster stop
/admin/environment/cluster/:
post:
security:
- BearerAuth: []
operationId: clusterCreate
tags:
- Environment Cluster
summary: Create the cluster
requestBody:
content:
application/json:
schema:
allOf:
- type: object
properties:
compute_template_id:
type: string
type:
type: string
responses:
'200':
description: Ok.
content:
application/json:
schema:
allOf:
- type: object
properties:
message:
type: string
result:
type: object
properties:
message:
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
x-operation-id-source: normalized
x-operation-id-original: cluster create
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
BasicAuth:
type: http
scheme: basic