compute

GET /v1/compute/servers/{serverId}/add-on

The add-on this machine carries.

All compute endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/compute/servers/{serverId}/add-on \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

⭐ **Singular, and three verbs on one path**, because a machine carries exactly one add-on at a time — a partial unique index in the database says so. A `/add-ons` collection would imply a list the customer can grow and then refuse the second one. ⛔ Answers `200` with `data: null` for a bare machine, **never** `404`. "This machine has no add-on" is an answer; a 404 here would mean "no such machine", and a client cannot tell those apart from a status code alone. Requires `sites.view`.

Parameters

NameTypeRequiredWhat it is
serverId (path)UuidYesThe server's id, as `listComputeServers` reports it. **Ours** (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine.

Response

NameTypeRequiredWhat it is
dataComputeAddOnAssignmentYes

Errors this endpoint can return

401 · 403 · 404 · 429