API ReferenceGroupsBeta
List your firewall groupsBeta
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.Summaries only. footprint is what the group expands to on each
address — one rule spanning ten ports is ten objects everywhere it lands,
which is what the per-IP ceilings in meta.limits are measured against.
Fetch a single group to see its rules and the addresses it reaches.
Authorization
orgApiKey firewall-groups.readAuthorizationBearer <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.read
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/firewall/groups"{ "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" } ], "meta": { "groups_count": 0, "limits": { "ip_rules_per_ip": 0, "geo_rules_per_ip": 0, "filters_per_ip": 0, "max_ports_per_group_rule": 0, "group_rules_max": 0, "group_assignments_max": 0, "group_prefix_min_length": 0, "group_prefix_targets_max": 0 } }}