Domains

Add a domain

Adds a domain and issues a DNS TXT verification challenge. Accepts what a person would type (a URL or a name with a trailing dot) and normalises it. Refuses IP addresses, public suffixes and reserved names. Adding a domain that was removed earlier restores it.

post/v1/domains

Request

  • Base URL: https://api.ironfang.com/security
  • URL: https://api.ironfang.com/security/v1/domains
  • Auth: HTTP bearer

Request body

domainstring required

Example request

{
  "domain": "example.co.uk"
}

Response

The domain, with its verification challenge.

authorisedboolean required
can_scanboolean required
created_atstring date-time required
display_namestring required
idstring uuid required
namestring required

ASCII (punycode) name.

next_scan_atstring date-time

When the cooldown ends.

scan_blocked_reason'verification_required' | 'authorisation_required' | 'policy_outdated' | 'scan_in_progress' | 'scan_cooldown' | 'daily_limit_reached' | 'organisation_suspended' | 'scans_paused' | 'security_disabled'

Why a scan cannot start now.

verification_status'waiting' | 'checking' | 'verified' | 'failed' | 'expired' | 'lapsed' required
discoveriesinteger required

Number of discovered names.

Changes

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