REST API reference


GET method to return the name and the version of the API. Useful to test if the API is up and running.


POST method to authenticate users on the REST API. Used when the authentication feature is enabled. Give the login and the password as JSON parameters. It returns an authentication token.

Example : curl -k -H "Content-Type: application/json" -X POST --data '{"login":"test","password":"test"}'

Each method below is a GET method with JSON data. In case when authentication is enabled, it must contain a token sent as Authorization request header. The second part of the header value must be the token:

Authorization: Bearer <TOKEN>

Example : curl -k -H "Authorization: Bearer <TOKEN>" -H "Content-Type: application/json" -X GET


Global settings about the supercomputer:



List of racks and nodes, with their sizes and positions:



List of all nodes:



List of all jobs:


One job details:



List of all partitions:



List of all QOS:



List of all reservations:



Topology defined on this cluster:



Return an sinfo style cluster status:


Jobs by node

Jobs running on the given node:


Jobs by node ids

Jobs running on the given nodes, ordered by nodes:


Give the list of node ids as a JSON array in the nodes parameter.

Jobs by nodes

Jobs running, ordered by nodes :


Jobs by QOS

Jobs running, ordered by qos :


Convert Nodeset

Convert a set of node formatted in host list to an array of nodes :


Give the nodeset by post method with a stringify JSON where the nodeset is passed to the key nodeset as a string (i.e. "{"nodeset":"pocn[234-240,257]"}"). No authentication needed for this route.