Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Common

Update Playbook Alert

Update a Playbook Alert. Generic alert properties like status, priority and assignee may be updated, or a log message may be appended.

put/common/{playbook_alert_id}

Path parameters

playbook_alert_idstring required

The unique id of a specific Playbook Alert

Request body

priority'High' | 'Moderate' | 'Informational'

The priority of the Playbook Alert.

status'New' | 'InProgress' | 'Dismissed' | 'Resolved'

The status of the Playbook Alert.

assigneestring

ID of the assignee

log_entrystring

Freetext log message. Maximum of 5000 characters.

reopen'Never' | 'SignificantUpdates'

Reopen strategies can only be applied to alerts with a status of Dismissed or Resolved.

The following combinations of status/reopen are allowed:

  • Dismissed -> Never
  • Resolved -> Never
  • Resolved -> SignificantUpdates
added_actions_takenOnwardActionId[]
removed_actions_takenOnwardActionId[]

Example request

{
  "status": "Resolved",
  "assignee": "uhash:40wXmPVONA",
  "log_entry": "This has been handled.",
  "added_actions_taken": [
    "cyber_vulnerability.patched",
    "brand_mentions_on_code_repository.keys_rotated",
    "domain_abuse.takedown",
    "malicious_sites.takedown",
    "third_party_risk.vendor_mitigated_findings",
    "identity_novel_exposures.enforced_password_reset"
  ],
  "removed_actions_taken": [
    "cyber_vulnerability.patched",
    "brand_mentions_on_code_repository.keys_rotated",
    "domain_abuse.takedown",
    "malicious_sites.takedown",
    "third_party_risk.vendor_mitigated_findings",
    "identity_novel_exposures.enforced_password_reset"
  ]
}

Response

Result of the update request.

status_code'Ok' | 'Error'

Status describing the result of the request.

status_messagestring

Text describing the status, suitable for displaying an error.

Example response

{
  "status_code": "Ok",
  "status_message": "Ok"
}