Playbook Alerts: Search

post

https://api.recordedfuture.com/playbook-alert/search

Find and filter playbook alerts by status, priority, category, assignee, or time range.

Body Params

from

integer

deprecated

Pagination offset, show items from this index and onwards. From + limit cannot exceed 10 000. This field is deprecated, use offset to paginate search responses instead.

limit

integer

Pagination limit, show items up to this limit. From + limit cannot exceed 10 000.

order_by

string

enum

Order results by created or modified data.

Allowed:

direction

string

enum

Order results ascending or descending.

Allowed:

entity

array of strings

Entity of the alert (ID). For Domain Abuse alerts the entity is the attacker domain and for Vulnerability Alerts the entity is the CVE.

entity

statuses

array of objects

Return Playbook Alerts with this status. Valid statuses can be listed in /metadata/common. If omitted or empty, all statuses will be selected.

statuses

priority

array of objects

Return Playbook Alerts with this priority. Valid priorities can be listed in /metadata/common. If omitted or empty, all priorities will be selected.

priority

category

assignee

array of strings

Return Playbook Alerts with this assignee. Valid assignees can be listed in /metadata/assignees. If omitted or empty, no filtering will be done on assignee.

assignee

created_range

object

Time range

updated_range

object

Time range

organisation

array of strings

Return Playbook Alerts with either of the organisations as owner. If omitted or empty, no filtering will be done on organisations.

organisation

offset

string

Allows pagination by using next_offset from previous search response

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of Playbook Alerts matching the search criteria