REST API

The Grid provides a REST API (gridcli works exclusively via the REST API). Both Swagger documentation and ReDoc documentation are available. An OpenAPI schema is also available. You must be logged in to the web interface to view them.

You can obtain an API token that will allow you to authenticate to the API without using a username and password via the API profile pane.

Using a token with gridcli

gridcli asks for your username and password unless you give it a token. To use a token instead, save it in a file that only you can read and run gridcli --token-file PATH, or pipe it to gridcli --token-file -. The --token TOKEN option also works, but it shows the token to every user who lists the running processes. gridcli saves the token in ~/.gridcredentials, readable only by you, so later commands need neither the token nor a password. The --no-save-credentials option prevents this.