API reference: allowlist

List the allowlist, allowlist an address or range from the WAF, the feeds or both, and remove an entry.

List the allowlist

GET /api/allowlist

Needs a Viewer or Admin key.

Replies

Status Meaning Body
200 OK list of AllowlistEntry

Reply fields

Field Type Description
ipOrCidr string The IP address, or range in CIDR form such as 198.51.100.0/24, that is exempt. Also the key used to remove the entry. Always present.
scope AllowScope What the address is exempt from: Waf, Feeds or Both. Always present. One of None, Waf, Feeds, Both.
reason string Why it was added, for whoever reviews the list later. Empty if none was given. Always present.
actor string Who added the entry. Always present.
addedAt date-time When the entry was added. Always present.

Allowlist an address or range

POST /api/allowlist

Needs an Admin key.

scope is Waf (never blocked by the WAF or by blocks), Feeds (never blocked by threat-intelligence feeds) or Both.

Request body: AllowlistRequest

Field Type Description
ipOrCidr string The IP address, or range in CIDR form such as 198.51.100.0/24, that is exempt. Also the key used to remove the entry. Required.
scope AllowScope What the address is exempt from: Waf, Feeds or Both. Required. One of None, Waf, Feeds, Both.
reason string Why it was added, for whoever reviews the list later. Empty if none was given. Optional.

Replies

Status Meaning Body
201 Created AllowlistEntry
400 Bad Request ApiError

Reply fields

Field Type Description
ipOrCidr string The IP address, or range in CIDR form such as 198.51.100.0/24, that is exempt. Also the key used to remove the entry. Always present.
scope AllowScope What the address is exempt from: Waf, Feeds or Both. Always present. One of None, Waf, Feeds, Both.
reason string Why it was added, for whoever reviews the list later. Empty if none was given. Always present.
actor string Who added the entry. Always present.
addedAt date-time When the entry was added. Always present.

Remove an allowlist entry

DELETE /api/allowlist/{ipOrCidr}

Needs an Admin key.

Give the address or range exactly as it was added; a range needs no escaping, for example /api/allowlist/198.51.100.0/24.

Parameters

Name In Type Notes
ipOrCidr path string Required.

Replies

Status Meaning Body
204 No Content none
404 Not Found none
Updated 2026-10-27Something unclear or missing? Tell us.