API ReferenceGroupsBeta

Re-queue a prefix's addresses that did not applyBeta

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.
POST
/firewall/groups/{group}/prefixes/retry

Re-queues every address in the prefix that is failed, paused or still pending, forced past the usual "already at this revision" check. Read the prefix's failed first: a rejection names the rule it refused, and retrying blind queues the same failure again.

Authorization

orgApiKey firewall-groups.manage
AuthorizationBearer <token>

An 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.manage

Path Parameters

group*integer

The group's id, as returned by the list endpoint. A group belonging to another organisation is a 404, never a 403 — a 403 would confirm the id is real.

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/firewall/groups/42/prefixes/retry" \  -H "Content-Type: application/json" \  -d '{    "cidr": "203.0.113.0/24"  }'
{  "data": {    "operation_id": 0,    "prefix": {      "cidr": "203.0.113.0/24",      "include_edges": true,      "address_count": 0,      "status": "pending",      "status_counts": {        "property1": 0,        "property2": 0      },      "failed": [        {          "ip": "192.168.0.1",          "last_error": "string"        }      ]    }  },  "message": "string"}