Alerts

List all audit alerts

Request

Definition

GET /api/v1/audit/alert_sets

Headers

• Authorization required

  Authentication token with privileges to view the resource.

  Bearer {token}

Query string parameters

Parameter	Type	Required	Description
paginate	boolean	No	If the result must be paginated.
page	integer	Yes if paginate is true	Page index.
page_size	integer	Yes if paginate is true	Number of items displayed per page.
alert_set_id	string	No	Filters operations whose alert_set_id matches the string entered.
alert_set_id_list	array<string>	No	Filters operations whose alert_set_id matches one of the list items.
timestamp_start	integer	No	Filters operations performed after the date entered.
timestamp_end	integer	No	Filters operations performed before the date entered.
username	string	No	Filters the operations performed by the user whose name matches the string entered.
username_list	array<string>	No	Filters the operations performed by the user whose name matches one of list items.
action	string	No	Filters operations where the action performed matches the string entered.
action_list	array<string>	No	Filters operations performed whose action matches one of list items.

Response

Status codes

Status code	Message
200	"List of audit alert_sets"
403	"Forbidden"

Body

Attributes

• data.audit_alert_sets.alerts_set_id string

  ID of the alert set concerned by the operation.

• data.audit_alert_sets.action string

  Executed action.

• data.audit_alert_sets.username string

  Username of the user who performed the operation.

• data.audit_alert_sets.timestamp integer

  Date in which the operation has been performed in UNIX format (microseconds).

• data.audit_alert_sets.additional_info object

  Some operation's additional informations.

Example

{
"data": {
    "audit_alert_sets": [
    {
        "action": "created",
        "additional_info": {},
        "alert_set_id": "00.X-2-0.xxxxV+pwj.xxxxxx6in",
        "timestamp": 1651131896000000,
        "username": "DevTest"
    }
    ]
},
"message": "List of audit alert_sets",
"status": "ok"
}