Include or leave out a prefix's edgesBeta
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.Turning include_edges on applies the group to the network and
broadcast addresses; turning it off removes the group's rules from them.
The prefix itself cannot be changed — remove it and apply the new one.
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 PATCH "https://example.com/firewall/groups/42/prefixes" \ -H "Content-Type: application/json" \ -d '{ "cidr": "203.0.113.0/24", "include_edges": true }'{ "data": { "operation_id": 0, "prefix": { "cidr": "203.0.113.0/24", "include_edges": true, "address_count": 0, "status": "pending", "status_counts": { "property1": 0, "property2": 0 }, "failed": [ { "ip": "192.168.0.1", "last_error": "string" } ] } }, "message": "string"}Apply a group to a whole prefix POST
Applies the group to every address in an IPv4 prefix your organisation owns, as one target. The mitigation network…
Remove a group from a whole prefix DELETE
Removes the group from every address it reaches through this prefix, in one operation. The prefix keeps reading back…