API Reference
List rules, narrowed by address, kind or filter
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.Paginated: limit (default 100, at most 1000) and offset, with meta.total and meta.next_offset in the answer. Ordered by kind (ip, then filter), then by id or by filter, address and port.
Authorization
BearerAuth firewall.readAuthorizationBearer <token>
Your organisation API key: Authorization: Bearer tbk_...
In: header
Scope: firewall.read
Query Parameters
ip?string
destination IPv4 to narrow to
kind?string
Value in
- "ip"
- "filter"
filter?string
a filter name or alias; implies kind=filter
limit?integer
page size, at most 1000
Range
1 <= value <= 1000Default
100offset?|
items to skip; the next page is offset + limit while next_offset is set
Range
0 <= valueDefault
0Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/rules"{ "data": [ { "kind": "ip", "destination": { "ip": "207.174.40.5", "port": 27015 }, "source": { "ip": "0.0.0.0", "port": 0 }, "protocol": "any", "action": "deny", "ref": "string", "id": 0, "expires_at": "string" } ], "meta": { "total": 0, "limit": 0, "offset": 0, "next_offset": 0 }}