API ReferenceGroupsBeta

Rename a group or change its descriptionBeta

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.
PATCH
/firewall/groups/{group}

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

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.

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" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "data": {    "id": 0,    "name": "string",    "description": "string",    "revision": 0,    "rule_count": 0,    "footprint": {      "ip": 0,      "geo": 0,      "filter": 0    },    "assignment_count": 0,    "updated_at": "2019-08-24T14:15:22Z"  },  "message": "string"}

Read one group, its rules and the addresses it reaches GET

assignments lists only live addresses; one the group has been detached from is history and is not returned.

Delete a group DELETE

By default this removes the group's rules from every address it reached. Pass preserve_rules=true to leave them in…