API Reference
List this key's jobs, newest first
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.Authorization
BearerAuth firewall.readAuthorizationBearer <token>
Your organisation API key: Authorization: Bearer tbk_...
In: header
Scope: firewall.read
Query Parameters
status?string
Value in
- "queued"
- "active"
- "completed"
- "failed"
limit?integer
Range
1 <= value <= 500Default
50Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/jobs"{ "data": [ { "id": "string", "status": "queued", "tenant": "string", "item_count": 0, "atomic": true, "ttl": 0, "submitted_at": "string", "started_at": "string", "finished_at": "string", "attempts": 0, "result": { "results": [ { "index": 0, "op": "create", "status": "created", "ref": "string", "rule": { "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" }, "error": { "code": "string", "message": "string" } } ], "summary": { "created": 0, "exists": 0, "deleted": 0, "absent": 0, "error": 0, "rolled_back": 0 } }, "error": "string" } ]}