API ReferenceGroupsBeta

Delete a groupBeta

Enabled per organisation

This endpoint answers 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.
DELETE
/firewall/groups/{group}

By default this removes the group's rules from every address it reached. Pass preserve_rules=true to leave them in place, unmanaged, and only drop the group.

A group that reaches no addresses is deleted immediately and operation_id is null. Otherwise the group survives until the queued work finishes — it still holds the rule definitions that say what to remove — so it will keep appearing in the list endpoint until then.

Authorization

orgApiKey firewall-groups.manage
AuthorizationBearer <token>

An 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

group*integer

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.

Query Parameters

preserve_rules?boolean

Leave the applied rules in place instead of removing them.

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/firewall/groups/42"
{  "data": {    "operation_id": 0  },  "message": "string"}

Rename a group or change its description PATCH

Neither field is part of what reaches the mitigation network, so nothing is re-applied and no operation is returned.

List the filter types a group rule may name GET

Published against the group endpoints rather than an address, unlike the per-IP filters/available, because a group is…