UPupguard
threatmonitoring

Close threat

Closes a specific threat, identified by UUID, with the given reason. The reason must be one of: false_positive, risk_accepted, remediated.

For reason 'false_positive': No additional parameters are required. For reason 'risk_accepted': The 'justification' parameter is required and must contain a free-form text explaining why the risk is accepted. For reason 'remediated': The 'remediation_reason' parameter is required and must be one of: content_removed_or_privatised, affected_users_credentials_reset, system_patched, requested_takedown, compensating_controls, other. If 'other', the 'remediation_description' parameter is also required.

Required API key permissions: BreachRisk (select when creating API key in Account Settings)

post/threatmonitoring/threat/close

Request

Query parameters

uuidstring uuid required

The unique identifier of the threat to close

reason'false_positive' | 'risk_accepted' | 'remediated' required

The reason for closing the threat. Must be one of: false_positive, risk_accepted, remediated

justificationstring

The justification for accepting the risk (required if reason is 'risk_accepted')

remediation_reason'content_removed_or_privatised' | 'affected_users_credentials_reset' | 'system_patched' | 'requested_takedown' | 'compensating_controls' | 'other'

The remediation reason. Must be one of: content_removed_or_privatised, affected_users_credentials_reset, system_patched, requested_takedown, compensating_controls, other (required if reason is 'remediated')

remediation_descriptionstring

Additional details for the remediation reason (required if remediation_reason is 'other')

Response

The closed threat

reasonstring

The reason the threat was closed

statusstring

The status of the threat after closing

uuidstring

The UUID of the threat that was closed

Changes

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