alerts

Create Subscription

Create a new domain-watch alert subscription for the authenticated key.

Tier-aware:

  • Free-tier keys may only set email — webhook_url is rejected with 403 webhook_requires_paid_tier.
  • Subscription count must remain below the caller's tier cap defined in TIER_LIMITS[<tier>]['alert_subscriptions']. Exceeding it returns 403 alert_quota_exceeded.
post/v1/alerts/subscriptions

Request

  • Base URL: https://api.ctindex.io
  • URL: https://api.ctindex.io/v1/alerts/subscriptions
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Cookies

ctix_sessionstring nullable

Request body

domainstring required
webhook_urlstring nullable
emailstring nullable
destination_typestring
destination_configobject nullable
enrichment_enabledboolean
match_typestring
keywordstring nullable
edit_distanceinteger
homoglyphsboolean
combosquatboolean
tld_setstring[] nullable

Response

Successful Response

idstring uuid required
domainstring required
webhook_urlstring nullable
emailstring nullable
destination_typestring
destination_configobject nullable
enrichment_enabledboolean
match_typestring
keywordstring nullable
edit_distanceinteger
homoglyphsboolean
combosquatboolean
tld_setstring[] nullable
last_event_atstring date-time nullable
last_event_deliveredboolean nullable
event_countinteger
created_atstring date-time nullable
signing_secretstring required

Changes

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