API

The control plane's REST API: every operation, with parameters, example requests and responses.

• OverviewHow to call the API: the address, signing in, options and paging, errors and their codes, safe retries, and the TypeScript client.
• SystemHealth, versions, sign-in, settings, metrics, who am I.
• InventoryServers, instances and logs, networks, storage, capacity and preflight.
• DeploymentSingle instances, moves and the job queue.
• ApplicationsApplications, drafts, versions, plans, deployments, operations and volumes.
• ClusterMembers, machines, join tokens, settings and recovery.
• AdministrationAPI tokens for scripts and automation: list, create and revoke.
• AuditThe audit log and its export.
• Identity and accessPeople, groups, roles, scopes, approvals, tokens and sign-in.
• SessionsTerminal sessions into modules.
• AlertsAlerts, silences and webhook channels.