Skip to content

REST Endpoints

Full specification: proto/openapi.yaml

MethodPathDescription
POST/api/v1/auth/loginPassword login
POST/api/v1/auth/logoutRevoke session
POST/api/v1/auth/step-upStep-up re-authentication
POST/api/v1/auth/totp-verifyVerify TOTP code
POST/api/v1/auth/passkey/beginBegin WebAuthn assertion
POST/api/v1/auth/passkey/completeComplete WebAuthn assertion
MethodPathDescription
GET/api/v1/setup/statusCheck if first-time setup is needed
POST/api/v1/setup/initCreate first owner account
MethodPathDescription
GET/api/v1/operatorsList operators
POST/api/v1/operatorsCreate operator
GET/api/v1/operators/meGet current operator
PATCH/api/v1/operators/meUpdate profile (name, phone, timezone, job_title)
DELETE/api/v1/operators/{id}Delete operator
GET/api/v1/operators/me/tokensList API tokens
POST/api/v1/operators/me/tokensCreate API token
DELETE/api/v1/operators/me/tokens/{id}Revoke token
MethodPathDescription
GET/api/v1/serversList servers
POST/api/v1/serversCreate server record
GET/api/v1/servers/{id}Get server
DELETE/api/v1/servers/{id}Delete server
POST/api/v1/servers/{id}/enrolEnroll agent
MethodPathDescription
GET/api/v1/sitesList sites
POST/api/v1/sitesCreate site
GET/api/v1/sites/{id}Get site
PATCH/api/v1/sites/{id}Update site
DELETE/api/v1/sites/{id}Delete site
GET/api/v1/sites/{id}/deploymentsList deployments
POST/api/v1/sites/{id}/deployTrigger deployment
GET/api/v1/sites/{id}/filesList directory
GET/api/v1/sites/{id}/files/contentRead file
PUT/api/v1/sites/{id}/files/contentWrite file
POST/api/v1/sites/{id}/files/uploadUpload file
GET/api/v1/sites/{id}/files/downloadDownload file/dir
POST/api/v1/sites/{id}/files/copyCopy
POST/api/v1/sites/{id}/files/moveMove
DELETE/api/v1/sites/{id}/filesDelete
MethodPathDescription
GET/api/v1/domainsList domains
POST/api/v1/domainsAdd domain
GET/api/v1/domains/{id}Get domain
DELETE/api/v1/domains/{id}Delete domain
GET/api/v1/domains/{id}/dns-recordsList DNS records
POST/api/v1/domains/{id}/dns-recordsCreate record
PUT/api/v1/domains/{id}/dns-records/{rid}Update record
DELETE/api/v1/domains/{id}/dns-records/{rid}Delete record
POST/api/v1/domains/{id}/dns-records/batchAtomic batch replace
MethodPathDescription
GET/api/v1/database-serversList DB servers
POST/api/v1/database-serversAdd DB server
GET/api/v1/databasesList databases
POST/api/v1/databasesCreate database
GET/api/v1/databases/{id}/connection-stringGet connection string (step-up)
MethodPathDescription
GET/api/v1/backup/targetsList targets
POST/api/v1/backup/targetsAdd target
POST/api/v1/backup/targets/{id}/testTest connectivity
GET/api/v1/backup/jobsList jobs
POST/api/v1/backup/jobsCreate job
POST/api/v1/backup/jobs/{id}/runRun now
GET/api/v1/backup/snapshotsList snapshots
POST/api/v1/backup/snapshots/{id}/restoreInitiate restore (preview)
POST/api/v1/backup/restores/{id}/confirmConfirm restore
MethodPathDescription
GET/api/v1/audit-logCursor-paginated audit entries
MethodPathDescription
GET/api/v1/healthzLiveness probe
GET/api/v1/readyzReadiness probe (includes DB check)