Version 2.4.7.20261116085428 · latest

High-risk IP library intel

The platform-provided high-risk IP library (paid item rules update, synced hourly): status, platform-wide handling policy, entry lookup, whitelisting a single entry and today's visits that hit it; read-only for tenants.

Pick an endpoint to see its example call on the right.

ProtectionAuthentication: Admin only7 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/intelGet high-risk IP library status

Authentication: User (some parameters admin only)

POST/api/v2/intel/allowWhitelist a high-risk IP

Authentication: Admin only

Request body application/json

FieldTypeDescription
ipRequiredstring Address or network.
reasonstring Why it is whitelisted (kept on the whitelist entry); defaults to a fixed note when omitted.
GET/api/v2/intel/ipsList high-risk IP library entries

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
ipstring A single address returns the entry covering it; anything else filters by substring of the CIDR text (admins only; tenants must give a single address).
levelIntelLevel Filter by level.
Values ["high","medium"]
reasonIntelReason Filter by type.
Values ["scanner","exploit","cc"]
PUT/api/v2/intel/policyUpdate high-risk IP library policy

Authentication: Admin only

Request body application/json

FieldTypeDescription
actionRequiredIntelAction Handling: challenge (pass only after a JS check), block (ban on the site and answer 403), log (record only).
Values ["challenge","block","log"]
levelRequiredIntelLevel Level: high (exploit type or score >= 80); medium.
Values ["high","medium"]
GET/api/v2/intel/suspectsList suspicious IP report status

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
statusIntelSuspectStatus Filter by status; omit for all.
Values ["queued","pending","admitted","ignored"]
ipstring Only these addresses (comma-separated, at most 200), for labelling IPs in lists such as bans; invalid addresses are ignored.
POST/api/v2/intel/suspectsReport suspicious IPs

Authentication: Admin only

Request body application/json

FieldTypeDescription
ipsRequiredstring[] Single IP addresses (no networks).
reasonstring Why it is whitelisted (kept on the whitelist entry); defaults to a fixed note when omitted.
GET/api/v2/intel/visitorsHigh-risk IPs that visited today

Authentication: User (some parameters admin only)

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
tenant_idinteger Admin only: filter by tenant (a malformed value returns 422). Ignored for tenant credentials, which only see their own tenant's data
site_idinteger Filter by site.

High-risk IP library object

FieldTypeDescription
actionRequiredIntelAction Handling: challenge (pass only after a JS check), block (ban on the site and answer 403), log (record only).
Values ["challenge","block","log"]
actionsIntelAction[] Handling applied to it today.
added_atstring When the entry was added (kept when the same IP is written again).
read-only
cidrstring Address or network (canonical form).
countinteger Number of entries.
entryIntelEntry One entry of the high-risk IP library.
errorstring Why the latest sync failed (the version in use is kept); empty on success.
expires_atstring Expiry time; empty = permanent. An expired entry stops matching by itself (nodes judge by their own clock, independent of the master); the master then removes it and the next config push carries the removal. Must be in the future when written.
first_seen_atstring When it first entered the library; absent when the library does not say.
generated_atstring When the library was generated (on the super admin side).
haltstring Why updates are halted by the license (expired, disabled, or the super admin unreachable for long) (admins only; not a failure, separate from error; absent when not halted).
highinteger Number of high-risk entries.
hitsinteger Times blocked in the 24 hours before the report.
ipRequiredstring Address or network.
ipsRequiredstring[] Single IP addresses (no networks).
itemsIntelSuspectResult[] Items on this page
last_atstring Time of the latest hit.
levelIntelLevel Level: high (exploit type or score >= 80); medium.
Values ["high","medium"]
mastersinteger Number of controllers that reported it within 24 hours; absent when the library does not say.
mediuminteger Number of medium-risk entries.
modeIntelSuspectMode How it was reported: auto (automatic conditions) or manual (by an admin or a manual ban).
Values ["auto","manual"]
policyIntelPolicy Platform-wide policy of the high-risk IP library; the site config field intel.action can override or turn it off.
queuedinteger Number of entries queued.
reasonstring Why it is whitelisted (kept on the whitelist entry); defaults to a fixed note when omitted.
reported_atstring When it was last reported.
scoreinteger Risk score (1-100).
servingboolean Whether a library is being pushed to nodes (fetched at least once and not expired).
sitesinteger Number of sites involved.
sourceIpListSource Where the entry came from: manual (added by hand), import (bulk import), ip_detail (blacklisted/whitelisted from the IP detail page), api (written through the API).
Values ["manual","import","ip_detail","api"]
staleboolean The license no longer carries the library and the last version is over 24 hours old, so it is no longer served.
statusIntelSuspectStatus Suspicious IP status: queued (not sent yet), pending (reported, awaiting review), admitted (added to the high-risk IP library), ignored.
Values ["queued","pending","admitted","ignored"]
status_atstring When the status last changed; null before it is sent.
substring Sub-type (for example WAF consecutive hits); absent when the library does not say.
synced_atstring Time of the latest sync.
versionstring Version of the library being served; empty if none.

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command