slurmrestd

Start REST API on a port

$ slurmrestd [host]:port

$ slurmrestd unix:/path/to/socket

$ slurmrestd -g [group_id] [host]:port

$ slurmrestd -a [auth_plugins] [host]:port

$ slurmrestd -f [path/to/slurm.conf]

$ slurmrestd -u [user_id] [host]:port

$ slurmrestd --generate-openapi-spec

slurmrestd [OPTIONS]... <[host]:port|unix:/path/to/socket>...

slurmrestd provides a REST API interface to Slurm workload manager. It operates in two modes: Inetd Mode for piped input via inetd, xinetd, or systemd socket activation, and Listen Mode for opening sockets on specified addresses.
The daemon supports authentication via local UNIX socket credentials or JWT tokens. Multiple listening endpoints can be specified, including TCP ports and Unix sockets. TLS encryption is supported by prefixing addresses with https://.

-a plugin[,plugin]

Comma-delimited list of authentication plugins to load

Data parser plugins for output formatting

OpenAPI plugins determining available endpoints

Read Slurm configuration from specified file

Change group ID and drop supplemental groups

Change user ID before processing requests

Number of processing threads

Maximum concurrent connections (default: 124)

Output JSON OpenAPI schema and exit

Verbose mode (up to 6 levels)

Print version information

Display help

Requires proper Slurm configuration and authentication setup. JWT authentication requires proper key configuration. Running with elevated privileges then dropping to unprivileged user is recommended. API endpoints vary based on loaded plugins and Slurm version.

slurmrestd was added to Slurm in version 20.02 (released 2020) to provide modern REST API access for programmatic cluster interaction. It enables integration with web interfaces, monitoring systems, and automation tools. Maintained by SchedMD as part of the core Slurm distribution.

slurmctld(8), sbatch(1), squeue(1), sacct(1)