API ReferenceGroupsBeta

Remove a group from addressesBeta

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}/assignments

One operation for the whole batch. Removing addresses one at a time queues a job each and serialises them behind one another.

preserve_rules: true unlinks without removing: the rules stay on the address, unmanaged. The default removes them.

An address this group does not reach is simply not in the set to remove. If none of the addresses named are reached by this group, the response is a 404.

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 DELETE "https://example.com/firewall/groups/42/assignments" \  -H "Content-Type: application/json" \  -d '{    "ips": [      "192.168.0.1"    ]  }'
{  "data": {    "operation_id": 0,    "removed": [      "192.168.0.1"    ]  },  "message": "string"}