Threat intelligence

Register assets and sweep them against the IOC corpus

A watchlist scoped to your API key. register adds domains and IPs, sweep checks them against the IOC corpus (8.3M+ citations, from 123 monitored criminal Telegram marketplaces and authoritative feeds), list returns what is registered, remove deletes entries. Once a webhook is configured, new matches against registered assets are pushed to you automatically.

Billing. $0.15 per successful call. Failed calls are never billed. Charged against prepaid credits when the balance covers it, otherwise metered to your card. Threat Intelligence subscribers and AWS Marketplace bundle customers call this at no extra charge.

Note. The watchlist is keyed on your API key, so a rotated key starts with an empty watchlist. Configure delivery with /v1/webhook/configure before registering assets if you want push alerts.

post/v1/metered/asset-intel

Request

  • Base URL: https://api.relayshield.net
  • URL: https://api.relayshield.net/v1/metered/asset-intel
  • Auth: one of:
    • API key in header X-RS-API-KEY
    • HTTP bearer

Request body

action'sweep' | 'register' | 'list' | 'remove'

Operation to perform. Defaults to sweep.

assetsstring[]

Domains or IPs. Required for register. Optional for sweep -- when omitted, your registered watchlist is swept instead. register caps at 50 per call.

Response

Success. ok is true and data holds the result.

oktrue required

Changes

No recorded changes to this operation across all 1 revision of this API.