API Reference

Complete list of REST API endpoints

All endpoints are under /api/v1/. Authentication is required unless noted.

Authentication

MethodPathAuthDescription
GET/api/v1/auth/setup-statusNoneCheck if setup is needed
POST/api/v1/auth/setupNoneCreate initial admin account
POST/api/v1/auth/loginNoneLogin, returns JWT + refresh cookie
POST/api/v1/auth/refreshCookieRefresh access token
POST/api/v1/auth/logoutCookieInvalidate refresh token
POST/api/v1/auth/enrollTokenEnroll a new node

Nodes

MethodPathAuthDescription
GET/api/v1/nodesJWTList all nodes
GET/api/v1/nodes/:idJWTGet node details
PUT/api/v1/nodes/:idJWTUpdate node (name, tags)
DELETE/api/v1/nodes/:idJWTDelete a node
GET/api/v1/nodes/:id/statsJWTGet system stats
POST/api/v1/nodes/:id/ws-tokenBearerGet WebSocket token
POST/api/v1/nodes/:id/updateJWTTrigger self-update
POST/api/v1/nodes/:id/uninstallJWTTrigger uninstall

Repositories

MethodPathAuthDescription
GET/api/v1/reposJWTList repositories
POST/api/v1/reposJWTCreate repository
GET/api/v1/repos/:idJWTGet repository details
PUT/api/v1/repos/:idJWTUpdate repository
DELETE/api/v1/repos/:idJWTDelete repository
POST/api/v1/repos/:id/pruneJWTTrigger prune
POST/api/v1/repos/:id/checkJWTTrigger integrity check
POST/api/v1/repos/:id/statsBearerReport repo stats (node)
POST/api/v1/repos/:id/refresh-statsJWTRefresh stats via node
GET/api/v1/repo-statsJWTLatest stats for all repos

Plans

MethodPathAuthDescription
GET/api/v1/plansJWTList plans
POST/api/v1/plansJWTCreate plan
GET/api/v1/plans/:idJWTGet plan details
PUT/api/v1/plans/:idJWTUpdate plan
DELETE/api/v1/plans/:idJWTDelete plan
POST/api/v1/plans/:id/duplicateJWTDuplicate plan

Jobs

MethodPathAuthDescription
GET/api/v1/jobsJWTList jobs
POST/api/v1/jobsJWTCreate/trigger job
GET/api/v1/jobs/:idJWTGet job details
POST/api/v1/jobs/:id/progressBearerReport progress (node)
POST/api/v1/jobs/:id/resultBearerReport result (node)

Snapshots

MethodPathAuthDescription
GET/api/v1/snapshotsJWTList snapshots
GET/api/v1/snapshots/:id/browseJWTBrowse snapshot files
GET/api/v1/snapshots/:id/downloadJWTDownload file/folder

Restore Jobs

MethodPathAuthDescription
GET/api/v1/restore-jobsJWTList restore jobs
POST/api/v1/restore-jobsJWTCreate restore job
GET/api/v1/restore-jobs/:idJWTGet restore job details

Tokens

MethodPathAuthDescription
GET/api/v1/tokensJWTList enrollment tokens
POST/api/v1/tokensJWTCreate token
DELETE/api/v1/tokens/:idJWTRevoke token

Events

MethodPathAuthDescription
POST/api/v1/events/tokenJWTGet SSE auth token
GET/api/v1/eventsTokenSSE event stream

Agent

MethodPathAuthDescription
GET/api/v1/agent/downloadNoneDownload node agent binary
GET/api/v1/agent/versionNoneGet latest agent version
GET/install.shNoneNode install script

Health

MethodPathAuthDescription
GET/api/v1/healthNoneHealth check