UPupguard
threatmonitoring

Add remediation request to threat

Changed on

Creates a remediation request for a specific threat, identified by UUID, and places the threat into the remediation state. The remediation request is assigned to the specified email address.

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

post/threatmonitoring/threat/remediation_request/add

Request

Query parameters

uuidstring uuid required

The unique identifier of the threat to place into remediation

emailstring required

The email address to assign the remediation request to

titlestring

The title for the remediation request. If not provided, will use the threat title

due_datestring date-time

Optional due date for the remediation request. Accepts YYYY-MM-DD (interpreted as UTC midnight) or RFC3339. Must not be in the past

reminder_datestring date-time

Optional reminder date for the remediation request. Requires due_date to be set. Accepts YYYY-MM-DD (interpreted as UTC midnight) or RFC3339. Must not be in the past or after due_date

copy_threat_commentsboolean

If true, copies all threat comments to the remediation request. Ignored when this call reopens the threat's previous, archived remediation request instead of creating a new one, because those comments were already copied when that request was first created

Request body

email_messagestring

Optional email message to include when inviting the user. Must not exceed 4000 characters.

Example request

{
  "email_message": "Please review and remediate this threat"
}

Response

The remediation request that was created

remediation_request_idinteger

The ID of the created remediation request

statusstring

The status of the threat after being placed into remediation

threat_uuidstring

The UUID of the threat that was placed into remediation

Changes