Changes

Acknowledge a change

Records that someone has reviewed the change. It never changes the finding it is about. Acknowledging twice keeps the first.

post/v1/changes/{changeId}/acknowledge

Request

  • Base URL: https://api.ironfang.com/security
  • URL: https://api.ironfang.com/security/v1/changes/{changeId}/acknowledge
  • Auth: HTTP bearer

Response

The change, acknowledged.

detailsobject required

Before and after where a change has them: a replaced certificate's issuer, names and expiry; a record's values. Expiry warnings carry milestone, not_after, seen_at and, when Ironfang could not look again before warning, confirmed: false.

domainstring required
domain_idstring uuid required
finding_idstring uuid
group'new' | 'resolved' | 'exposure' | 'certificates' | 'dns' | 'monitoring' required

The Changes feed's filters.

hoststring
idstring uuid required
occurred_atstring date-time required
previous_scan_idstring uuid

The scan it was compared with.

scan_idstring uuid

The scan that found it. Absent for expiry warnings between scans.

severity'critical' | 'high' | 'medium' | 'low' | 'info' required
summarystring required

Plain English, safe to show as is.

titlestring required
type'finding_new' | 'finding_resolved' | 'finding_recurred' | 'finding_severity_increased' | 'finding_severity_decreased' | 'service_exposed' | 'service_removed' | 'certificate_changed' | 'certificate_expiring' | 'certificate_expired' | 'tls_configuration_weakened' | 'tls_configuration_improved' | 'dns_record_changed' | 'dns_security_weakened' | 'dns_security_improved' | 'spf_changed' | 'dmarc_changed' | 'email_security_weakened' | 'email_security_improved' | 'http_security_weakened' | 'http_security_improved' | 'monitoring_scan_failed' | 'monitoring_scan_recovered' | 'monitoring_paused' required

Changes

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