Skip to main content
POST
security.host.count

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
query
string

Literal text to match; never a source-specific query language.

Required string length: 1 - 4096
filters
object

Structured filters; unsupported combinations are declined.

countLevel
enum<string>
default:service

Count host documents or service documents; sources decline unsupported levels.

Available options:
host,
service
facets
object[]

Up to five distinct fields; default none.

Maximum array length: 5

Response

The result

total
integer
required

Total documents, including zero.

Required range: 0 <= x <= 9007199254740991
relation
enum<string>
required

Count precision.

Available options:
exact,
at-least
countLevel
enum<string>
required

Document level counted.

Available options:
host,
service
facets
object[]
required

Requested value counts.

Maximum array length: 5