API Reference
Delete a batch by refs and/or by matching shape
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.More than sync_max_items (4) items must set mode: async; at most max_batch_size (1000) per request.
Authorization
BearerAuth firewall.manageAuthorizationBearer <token>
Your organisation API key: Authorization: Bearer tbk_...
In: header
Scope: firewall.manage
Query Parameters
mode?string
Value in
- "sync"
- "async"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/rules/delete" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "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 } }}