Poll a queued group operationBeta
Enabled per organisation
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.Every write that changes what a group applies answers with an
operation_id. This is where you follow it.
Poll until finished is true, then check failed. A finished
operation with a non-zero failed is not a success — results names
the addresses that did not take, and each one can be retried
individually.
Polling once a second is ample; the work is bounded by how fast the mitigation network accepts writes, not by this endpoint.
Authorization
orgApiKey firewall-groups.readAn 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-groups.read
Path Parameters
The operation_id returned by whichever write queued the work.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/firewall/groups/operations/1043"{ "data": { "id": 0, "firewall_group_id": 0, "type": "reconcile", "status": "pending", "finished": true, "total": 0, "processed": 0, "succeeded": 0, "failed": 0, "results": [ {} ], "error": "string" }}