API Reference

Get one rule by ref

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.
GET
/rules/{ref}

Authorization

BearerAuth firewall.read
AuthorizationBearer <token>

Your organisation API key: Authorization: Bearer tbk_...

In: header

Scope: firewall.read

Path Parameters

ref*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rules/filter:mcje:207.174.40.5:25565"
{  "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"  }}

List rules, narrowed by address, kind or filter GET

Paginated: limit (default 100, at most 1000) and offset, with meta.total and meta.next_offset in the answer. Ordered…

Create one rule or a batch POST

Send a single rule object, or {rules: [...]} for a batch. Each item reports created, exists or error; atomic: true…