This REST API lets you build custom solutions when you need to monitor the cluster and take other actions automatically. The API follows standard REST principles and can be used in various languages and tools (Java, Pyhton, Node, curl...).

The following sections let you browse the reference documentation of the supported API. We distinguish between the cluster and the node endpoints. Cluster endpoints provide cluster-wide APIs and any of the nodes from the same cluster can be used. On the other hand, node endpoints provides node specific APIs, for example to manage the configuration of a node or access a running or recently completed job on a specific node.

The documentation is also interactive and lets you try out the API endpoints. To do so, you will need to provide the client or administrator password in the X-GUROBI-CSPASSWORD header parameter. Note that this is not a simulation and by interacting with the documentation, you are able to access active data of your cluster.