Skip to content

Reference data

The values other settings accept: country codes and country groups for geo, autonomous systems for asn (search by name or number), crawler names for crawler in MatchNode and allowlists, and the allowed HealthCheck settings. Read-only; requests need API access.

Endpoints

Method Path Key Purpose
GET /reference/asns read Autonomous systems for rules and allowlists
GET /reference/countries read Country codes
GET /reference/crawlers read Known crawlers for allowlists
GET /reference/geo-groups read Country groups
GET /reference/health-check-options read Allowed health check settings

GET /reference/asns

Returns: 200, Asns

Answer 200
{
  "asns": []
}

GET /reference/countries

Returns: 200, Countries

Answer 200
{
  "countries": []
}

GET /reference/crawlers

Returns: 200, Crawlers

Answer 200
{
  "crawlers": []
}

GET /reference/geo-groups

Returns: 200, GeoGroups

Answer 200
{
  "geo_groups": []
}

GET /reference/health-check-options

Returns: 200, HealthCheckOptions

Answer 200
{
  "paths": [
    "/",
    "/health",
    "/healthz"
  ],
  "intervals": [
    "5s",
    "10s",
    "15s"
  ],
  "expects": [
    "status 200",
    "status 2xx",
    "status 301"
  ]
}

Example

curl -s -H "Authorization: Bearer $ZP_KEY" "$API/reference/asns" | jq 'any(.asns[]; . == 3320)'