Replace a rule in a groupBeta
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.The body is the rule's whole new definition, not a partial patch — fields belonging to other kinds are cleared, so a rule edited from one kind to another cannot keep stale values behind.
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.
The rule's id, as returned when reading the group.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The rule's whole definition. kind decides which other fields apply;
fields belonging to other kinds are ignored and cleared.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/firewall/groups/42/rules/7" \ -H "Content-Type: application/json" \ -d '{ "kind": "ip" }'{ "data": { "operation_id": 0, "revision": 0, "rule": { "id": 0, "kind": "ip", "destination_port": "25565", "all_ports": true, "expanded_port_count": 0, "action": "allow", "protocol": "tcp", "source_ip": "string", "country_code": "string", "source_asn": 0, "filter_type": "string", "filter_name": "string", "note": "string", "tags": [ "string" ], "summary": "string" } }, "message": "string"}