API ReferenceFirewall
Read the rules and filters on one IP
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.Read meta.limits rather than hardcoding the per-IP ceilings — they are
configuration and can differ from the defaults shown here.
Authorization
orgApiKey firewall.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.read
Path Parameters
ip*string
An address inside a prefix you announce, or one assigned to one of your
services. Anything else is a 404.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/firewall/ips/192.0.2.10"{ "data": { "ip": "string", "rules": [ { "id": 0, "action": "allow", "protocol": "tcp", "source_ip": "string", "destination_ip": "string", "destination_port": 0, "managed_by_group": { "id": 0, "name": "string" } } ], "filters": [ { "key": "synproxy:25565", "type": "string", "name": "string", "port": 0, "managed_by_group": { "id": 0, "name": "string" } } ] }, "meta": { "rules_count": 0, "filters_count": 0, "limits": { "rules_per_ip": 100, "filters_per_ip": 25, "max_ports_per_request": 101 } }}