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}/firewall \
-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
The firewall applied to this machine and the rules in force. ⛔ Read `attached` before reading `rules`. No firewall and an empty firewall both come back looking empty and mean opposite things — one is "nothing is protecting this machine", the other is "a filter is in place and permits nothing". Requires `sites.view`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
serverId (path) | Uuid | Yes | The 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
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | The provider's firewall id |
name | string | Yes | Its name at the provider |
attached | boolean | Yes | Whether a firewall resource is actually applied to this machine. |
rules | ComputeFirewallRule[] | Yes | — |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429 · 503