Scans

Run the External Security Check

Queues a full scan of a verified, authorised domain. The verification record is looked up again first; if it has been removed the domain returns to unverified and the scan is refused. Subject to a cooldown per domain, a daily limit and one running scan per organisation.

post/v1/domains/{domainId}/scans

Request

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

Response

The queued scan.

domainstring required
domain_idstring uuid required
duration_msinteger
failure_class'asset' | 'ironfang'

For a failed scan, whose problem it was — the domain did not answer, or Ironfang could not run it.

finished_atstring date-time
idstring uuid required
kind'full' | 'recheck' | 'certificate' required

certificate is monitoring looking at one host's certificate again before warning that it is about to expire.

recheck_finding_idstring uuid
requested_atstring date-time required
started_atstring date-time
status'queued' | 'running' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'killed' required
status_reasonstring

Why a scan was cancelled, stopped or failed.

trigger'manual' | 'recheck' | 'monitoring' | 'admin' | 'api' required

Why a scan ran.

disclaimerstring required
limitationsstring[] required
policy_versionstring required
previous_scan_idstring uuid

The domain's previous full scan, to compare with.

Changes

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