Skip to main content
POST
security.ip.blacklist.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
confidenceMinimum
integer
default:90

Minimum abuse confidence, 25 to 100; default 90. Custom thresholds require entitlement.

Required range: 25 <= x <= 100
limit
integer
default:100

At most 1,000 addresses; default 100.

Required range: 1 <= x <= 1000
onlyCountries
string[]

Include these country codes only; subscriber feature.

Required array length: 1 - 50 elements
Pattern: ^[A-Z]{2}$
exceptCountries
string[]

Exclude these country codes; subscriber feature.

Required array length: 1 - 50 elements
Pattern: ^[A-Z]{2}$
ipVersion
enum<string>
default:either

IPv4, IPv6, or either.

Available options:
4,
6,
either

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.