Skip to main content

Module types

Module types 

Source
Expand description

Request and response types.

Structs§

AgentBatch
Response of POST /v1/agentscan/batch.
AgentBatchLine
One log line for POST /v1/agentscan/batch.
AgentBatchResult
One classified line of a batch.
AgentCheck
Response of POST /v1/agentscan/check.
AgentCheckRequest
Body of POST /v1/agentscan/check.
AgentSelfCheck
Response of POST /v1/agentscan/self.
AgentSelfRequest
Body of POST /v1/agentscan/self. Every field is optional.
AllowlistAgent
One entry of GET /v1/agentscan/allowlist.
Anchor
A daily root hash anchoring the chain.
AnchoredVerification
Response of POST /v1/provenance/verify.
AsnDetail
Response of GET /v1/asn/directory/{asn}.
AsnPrefix
A sample prefix announced by an autonomous system.
AsnResponse
Response of GET /v1/asn/{ip}.
AsnSearch
Response of GET /v1/asn/directory?q=.
AsnSummary
An autonomous system in the directory.
AsnTop
Response of GET /v1/asn/directory?top=.
AsnTopParams
Query parameters for the ASN directory top list.
BulkCheck
Response of POST /v1/bulk/check.
BulkEvent
One line of the POST /v1/ip/bulk NDJSON stream. Missing and null fields are zero values.
BulkRequest
Input for the bulk endpoints: a list of IPs, or a pasted blob the server splits.
BulkResult
One row of a bulk check. Score, grade, verdict, deductions and VPN brand are null on the Free plan.
Chain
Response of GET /v1/provenance/chain.
ChainLink
One attestation in the chain, with its verification state.
ChainParams
Query parameters for GET /v1/provenance/chain.
ChainSummary
Attestation counts by policy action.
ChainVerification
Response of GET /v1/provenance/verify.
Crawler
A crawler this service can verify.
CrawlerList
Response of GET /v1/crawlers.
CrawlerVerification
Response of POST /v1/agentscan/verify.
CrawlerVerifyRequest
Body of POST /v1/agentscan/verify. Set bot or user_agent.
Deduction
One factor that lowered a purity score.
EdgeCheck
Response of POST /v1/edge/check.
EdgeCheckRequest
Body of POST /v1/edge/check.
EdgeNetwork
The network half of an edge check.
EdgeSite
The site an edge check was attributed to.
EmailCheck
Response of POST /v1/email/check.
EmailChecks
The checks behind an email status.
ExportParams
Query parameters for GET /v1/provenance/export. Dates are RFC3339 or YYYY-MM-DD.
GateEmail
The email check of a gate verification.
GateNetwork
The network part of a gate verification.
GateVerification
Response of POST /v1/gate/verify. Wire names are snake_case.
GateVerifyRequest
Body of POST /v1/gate/verify.
GeolocationResponse
Response of GET /v1/geo/{ip}. Precise-location fields are null on the Free plan.
History
Response of GET /v1/ip/history.
HistoryEvent
One past lookup.
HistoryParams
Query parameters for GET /v1/ip/history.
Jurisdiction
A jurisdiction the policy engine knows.
Limits
Response of GET /v1/user/limits.
LookupResult
A full lookup, from POST /v1/ip/lookup or GET /v1/demo/{ip}.
MyIp
Response of GET /v1/myip.
ProvenanceCheck
Response of POST /v1/provenance/check. The API sends this one in snake_case.
ProvenanceCheckRequest
Body of POST /v1/provenance/check.
ProxyResponse
Response of GET /v1/proxy/{ip}.
Purity
The purity score and the deductions behind it.
ReservedRange
Whether the address is in a reserved range.
SitePolicy
Response of GET /v1/sites/{id}/policy.
Target
What a lookup target resolved to.
UsageSummary
Response of GET /v1/usage/summary.
Verdict
The network classification.
VerifyCheck
One check behind a crawler verification.
VpnResponse
Response of GET /v1/vpn/{ip}.
WhoisResponse
Response of GET /v1/whois/{domain}. Dates are the registry’s raw strings.
Window
A daily or hourly allowance.