HTTP API

View Markdown

Nodus serves every resource at a Kubernetes-style path, so kubectl, client-go and the generated clients all work against it:

GET    /apis/nodus.dev/v1/namespaces/{project}/jobs
POST   /apis/nodus.dev/v1/namespaces/{project}/jobs
GET    /apis/nodus.dev/v1/namespaces/{project}/jobs/{name}
GET    /apis/nodus.dev/v1/namespaces/{project}/jobs?watch=true

Authenticate with an API key as a bearer token (Authorization: Bearer nodus_sk_…). Lists page with limit and continue, writes accept an Idempotency-Key header, and ?dryRun=All validates a create and returns its estimate without charging anything. Errors are described in Error codes.

The per-operation reference in the sidebar is generated from the OpenAPI document, which is also served at /docs/openapi.json.