Remove a group from a whole prefixBeta
Enabled per organisation
403 until our staff enable the Firewall API flag on your organisation, and its ability cannot be granted to a key before then. Open a ticket saying what you intend to build — see Activation.Removes the group from every address it reaches through this prefix, in
one operation. The prefix keeps reading back as removing until the last
address is cleared, then disappears; an address that could not be cleared
keeps it, so the failure stays visible and retryable.
preserve_rules: true unlinks without removing: the rules stay on each
address, unmanaged. The default removes them.
The addresses of a prefix cannot be removed one at a time through
DELETE /assignments — that is refused with a 422 naming the prefix.
Authorization
orgApiKey firewall-groups.manageAn organisation API key, prefixed tbk_. Create one under
Organisation to API keys; the plaintext is shown once.
The scopes listed on each operation are the abilities the key must carry. They are not OAuth scopes and are not negotiated per request.
In: header
Scope: firewall-groups.manage
Path Parameters
The group's id, as returned by the list endpoint. A group belonging to
another organisation is a 404, never a 403 — a 403 would confirm
the id is real.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/firewall/groups/42/prefixes" \ -H "Content-Type: application/json" \ -d '{ "cidr": "203.0.113.0/24" }'{ "data": { "operation_id": 0, "removed": "string" }, "message": "string"}Include or leave out a prefix's edges PATCH
Turning include_edges on applies the group to the network and broadcast addresses; turning it off removes the group's…
Re-queue a prefix's addresses that did not apply POST
Re-queues every address in the prefix that is failed, paused or still pending, forced past the usual "already at this…