Skip to main content

Overview

The Palmetto API provides programmatic access to the Palmetto Cluster's Slurm scheduler and accounting database over HTTPS. It wraps the upstream Slurm REST API and adds authentication, authorization, rate limiting, and caching.

The API is available with the base URL of https://api.palmetto.clemson.edu.

Getting Started​

First, read through the different authentication options, including MUNGE within the cluster and API keys for use by node owners outside the cluster.

The API exposes two main groups of endpoints:

  • Slurm Controller (/slurm/{version}/...) — live cluster operations: query and submit jobs, inspect nodes and partitions, manage reservations
  • Slurm Database (/slurmdb/{version}/...) — accounting data: historical job records, user and account information, QOS definitions

See endpoints documentation for details.

Both groups support multiple API versions and a latest alias — see API Versioning.