Skip to main content
POST
Bulk lookup services

Authorizations

X-API-Key
string
header
required

Infrawatch API key. Supply the complete key directly as the header value.

Body

application/json

The complete encoded JSON request body is limited to 32 KiB (32768 bytes). CIDRs, IPv6 zones, unknown fields, duplicate JSON keys, and null values are rejected.

ip_addresses
string<ip>[]
required

IPs are canonicalized. Response positions preserve this array's order and duplicates.

Required array length: 1 - 100 elements

Canonical IPv4 or IPv6 address. CIDRs and IPv6 zones are not accepted.

Maximum string length: 64
limit_per_ip
integer
default:25

Maximum number of results returned for each input position.

Required range: 1 <= x <= 25

Response

Ordered, bounded service results. Per-IP failures return error items and partial=true; failure of the entire operation returns 503.

partial
boolean
required

True when at least one per-IP result has status=error because bucket-local execution failed. Failure before per-IP results can be produced is returned as 503 instead.

results
object[]
required

One item per requested IP in original input order; duplicate inputs produce duplicate response positions.

Required array length: 1 - 100 elements

status=ok includes one or more services and no error; status=not_found includes neither services nor error; status=error includes a stable error and no services.