/bgptools/prefixes/validation

POST /api/bgptools/prefixes/validation

Price: 10 credits

Get RPKI and IRR route-origin validation for a BGP prefix

How to use it

Check the route-origin security of a BGP prefix: its RPKI validity for the current origin (Valid / Invalid / Unknown), the matched ROAs (authorized origin AS, covered prefix, max length, and expiry), and the IRR database records (which registry, the expected origin AS, and whether it matches a trusted or unauthenticated source). Use for route-hijack detection and BGP security auditing. Accepts an IPv4 or IPv6 CIDR.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• prefix string required — IP prefix in CIDR notation to validate (examples: "1.1.1.0/24", "8.8.8.0/24", "2606:4700:4700::/48"; minLength: 1)

Response

• @type string (default: "BgptoolsPrefixValidation")
• prefix string required
• rpki_status string nullable
• irr array (default: [])
  • @type string (default: "BgptoolsIrrRecord")
  • irr_db string nullable
  • expected_asn integer nullable
  • match string nullable
  • raw string nullable
• matched_roas array (default: [])
  • @type string (default: "BgptoolsRoa")
  • asn integer required
  • prefix string required
  • max_length integer nullable
  • expires string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Prefix not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.