Dismissing alerts

Alerts can be dismissed by sending a DELETE request to the /api/alert_manager/v1/alerts endpoint using the query parameters described in this section.

Query parameters

Parameter

Type

Description

id

string

Case-insensitive IDs of the alerts to delete.

type

array of string

A filter by list of alert types.

category

array of string

A filter by list of alert categories.

tenant

array of string

Filter by one or more tenant IDs.

To filter by one tenant ID, specify a tenant ID: 2f4b84d8-6aad-487b-b0b1-40845bf72737.

To filter by multiple tenant IDs, specify tenants in the following format: or(2f4b84d8-6aad-487b-b0b1-40845bf72737,c70134c4-a244-4b22-99ad-e081301f7530).

severity

string

A filter by the alert severity.

Available severities:

  • critical

  • error

  • warning

  • information

Available operators:

  • eq - equals to the specified value: eq(warning).

  • or - equals to one of the specified values: or(warning,critical).

  • lt - less than the specified value: lt(warning).

  • gt - greater than the specified value: gt(warning).

  • le - less than or equals to the specified value: le(warning).

  • ge - greater than or equals to the specified value: ge(warning).

show_deleted

boolean

If true, dismissed alerts will be included in the response.

show_deleted_only

boolean

If true, only dismissed alerts will be included in the response.

updated_at

string

A filter by date in the UNIX nanoseconds timestamp format when the alert was created or dismissed.

Available operators:

  • eq - equals to the specified value: eq(1439789551045000000).

  • lt - less than the specified value: lt(1439789551045000000).

  • gt - greater than the specified value: gt(1439789551045000000).

  • le - less than or equals to the specified value: le(1439789551045000000).

  • ge - greater than or equals to the specified value: ge(1439789551045000000).

created_at

string

A filter by date in the UNIX nanoseconds timestamp format when the alert was created.

Available operators:

  • eq - equals to the specified value: eq(1439789551045000000).

  • lt - less than the specified value: lt(1439789551045000000).

  • gt - greater than the specified value: gt(1439789551045000000).

  • le - less than or equals to the specified value: le(1439789551045000000).

  • ge - greater than or equals to the specified value: ge(1439789551045000000).

deleted_at

string

A filter by date in the UNIX nanoseconds timestamp format when the alert was dismissed.

Available operators:

  • eq - equals to the specified value: eq(1439789551045000000).

  • lt - less than the specified value: lt(1439789551045000000).

  • gt - greater than the specified value: gt(1439789551045000000).

  • le - less than or equals to the specified value: le(1439789551045000000).

  • ge - greater than or equals to the specified value: ge(1439789551045000000).

limit

integer

Number of the results returned in the response.

before

string

Cursor to the previous results page.

after

string

Cursor to the next results page.

Response structure

If the alerts were created successfully, the response returns status 204 without payload.

In this section