REST API Reference

The NodeFoundry REST API gives you programmatic access to every aspect of your cluster. All endpoints are served from the master node.

---

Base URL

All API requests are relative to your master node:

https://<master-ip>:<port>/api

Authentication

Most endpoints require authentication via JWT tokens stored in HTTP-only cookies. Authenticate by calling POST /user/login — the response sets access_token and refresh_token cookies automatically.

S3 endpoints use separate credentials passed via X-S3-Access-Key and X-S3-Secret-Key headers.

See Authentication for details.

Response format

All responses are JSON. Errors return a JSON body with an error field:

{ "error": "description of what went wrong" }

---

Endpoints