Expand description
Request and response types.
Structs§
- Agent
Batch - Response of
POST /v1/agentscan/batch. - Agent
Batch Line - One log line for
POST /v1/agentscan/batch. - Agent
Batch Result - One classified line of a batch.
- Agent
Check - Response of
POST /v1/agentscan/check. - Agent
Check Request - Body of
POST /v1/agentscan/check. - Agent
Self Check - Response of
POST /v1/agentscan/self. - Agent
Self Request - Body of
POST /v1/agentscan/self. Every field is optional. - Allowlist
Agent - One entry of
GET /v1/agentscan/allowlist. - Anchor
- A daily root hash anchoring the chain.
- Anchored
Verification - 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=. - AsnTop
Params - Query parameters for the ASN directory top list.
- Bulk
Check - Response of
POST /v1/bulk/check. - Bulk
Event - One line of the
POST /v1/ip/bulkNDJSON stream. Missing and null fields are zero values. - Bulk
Request - Input for the bulk endpoints: a list of IPs, or a pasted blob the server splits.
- Bulk
Result - 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. - Chain
Link - One attestation in the chain, with its verification state.
- Chain
Params - Query parameters for
GET /v1/provenance/chain. - Chain
Summary - Attestation counts by policy action.
- Chain
Verification - Response of
GET /v1/provenance/verify. - Crawler
- A crawler this service can verify.
- Crawler
List - Response of
GET /v1/crawlers. - Crawler
Verification - Response of
POST /v1/agentscan/verify. - Crawler
Verify Request - Body of
POST /v1/agentscan/verify. Setbotoruser_agent. - Deduction
- One factor that lowered a purity score.
- Edge
Check - Response of
POST /v1/edge/check. - Edge
Check Request - Body of
POST /v1/edge/check. - Edge
Network - The network half of an edge check.
- Edge
Site - The site an edge check was attributed to.
- Email
Check - Response of
POST /v1/email/check. - Email
Checks - The checks behind an email status.
- Export
Params - Query parameters for
GET /v1/provenance/export. Dates are RFC3339 orYYYY-MM-DD. - Gate
Email - The email check of a gate verification.
- Gate
Network - The network part of a gate verification.
- Gate
Verification - Response of
POST /v1/gate/verify. Wire names are snake_case. - Gate
Verify Request - Body of
POST /v1/gate/verify. - Geolocation
Response - Response of
GET /v1/geo/{ip}. Precise-location fields are null on the Free plan. - History
- Response of
GET /v1/ip/history. - History
Event - One past lookup.
- History
Params - Query parameters for
GET /v1/ip/history. - Jurisdiction
- A jurisdiction the policy engine knows.
- Limits
- Response of
GET /v1/user/limits. - Lookup
Result - A full lookup, from
POST /v1/ip/lookuporGET /v1/demo/{ip}. - MyIp
- Response of
GET /v1/myip. - Provenance
Check - Response of
POST /v1/provenance/check. The API sends this one in snake_case. - Provenance
Check Request - Body of
POST /v1/provenance/check. - Proxy
Response - Response of
GET /v1/proxy/{ip}. - Purity
- The purity score and the deductions behind it.
- Reserved
Range - Whether the address is in a reserved range.
- Site
Policy - Response of
GET /v1/sites/{id}/policy. - Target
- What a lookup target resolved to.
- Usage
Summary - Response of
GET /v1/usage/summary. - Verdict
- The network classification.
- Verify
Check - One check behind a crawler verification.
- VpnResponse
- Response of
GET /v1/vpn/{ip}. - Whois
Response - Response of
GET /v1/whois/{domain}. Dates are the registry’s raw strings. - Window
- A daily or hourly allowance.