List alerts

Returns the alerts for the specified security profile.

Requires one of the following license types: ioa, ioaPreview, or ioe. See License Types.

Requires the Read permission on the Profiles, Domains, and Indicators of Exposure entities (read:profile, read:directory, read:checker). See Identity Exposure Permissions.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[0-9]+$

Specifies the ID of the security profile.

Query Params
string
enum

Specifies whether to include archived alerts. If omitted, the system excludes them.

Allowed:
string
enum

Specifies whether to include alerts that have been read. Set to false to return only unread alerts. If omitted, the system includes them.

Allowed:
string
^[0-9]+$

Specifies the maximum number of alerts to return per page. The maximum is 500.

string
^[0-9]+$

Specifies the page of results to return. The first page is 1.

Responses

401

Returned if the API key specified in your request is invalid.

500

Returned if an internal error occurred.

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