API

Every method of the compute API, by group: 168 registered, 166 in PLAN.md §9.2.

Every method is POST /api/compute/{group}/{method} with a JSON object body, content-type: application/json and X-Better-Compute: 1 (else CSRF_REJECTED), at most 64 KiB. Answers are { "data": … } or { "error": { "code", "message", "details"? } }; see errors. Plugins are served under /api/compute/plugins/{id}/{group}/{method}.

A call is authenticated (except public methods), refused before any database access when the caller is outside the input tenant and the root tenant, and decided once on action @ resource. + items marks list methods, which also filter items one by one.

Group	Module	Methods	Served
`capacity`	`capacity`	4	4
`commandBatches`	`quorum`	7	7
`commands`	`server`	4	4
`drivers`	`server`	1	1
`events`	`server`	1	1
`flavors`	`vps`	4	4
`fleet`	`fleet`	4	4
`images`	`provision`	4	4
`instances`	`vps`	7	7
`inventory`	`inventory`	3	3
`joinRequests`	`server`	3	3
`joinTokens`	`server`	3	3
`metal`	`metal`	15	15
`nodes`	`server`	14	14
`pools`	`capacity`	8	8
`profiles`	`provision`	7	7
`projects`	`server`	4	4
`providerAccounts`	`vps`	7	7
`quotas`	`capacity`	2	2
`releases`	`rollout`	2	2
`reservations`	`capacity`	7	7
`rollouts`	`rollout`	6	6
`sandboxSnapshots`	`vps`	3	3
`sandboxTemplates`	`vps`	5	5
`sandboxVolumes`	`vps`	5	5
`sandboxes`	`vps`	7	7
`secrets`	`server`	2	2
`siteTokens`	`server`	2	2
`sites`	`server`	5	5
`system`	`server`	3	3
`tunnels`	`tunnels`	1	1
`usage`	`server`	2	2
`webhooks`	`events`	10	10
`workflows`	`provision`	6	6

On this page