API Documentation

Playbook Alerts: Update

put
https://api.recordedfuture.com/playbook-alert/common/

Manage alert lifecycle by changing status, priority, assignee, log messages, and reopen behavior.

Path Params
string
required

The unique id of a specific Playbook Alert

Body Params

added_actions_taken can only be set when status is set to Dismissed or Resolved.

string
enum

The priority of the Playbook Alert.

Allowed:
string
enum

The status of the Playbook Alert.

Allowed:
string

ID of the assignee

string

Freetext log message. Maximum of 5000 characters.

string
enum

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
Allowed:
added_actions_taken
array of objects

Playbook alert data object.

added_actions_taken
removed_actions_taken
array of objects

Playbook alert data object.

removed_actions_taken
Response

Updated about 1 month ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago