Alert definitions service

Get a list of all accessible alert definitions

Returns all alert definitions for the team.

Requires the following permissions:

  • alerts:ReadConfig
get/alerts/alerts/v3

Request

  • Base URL: https://api.eu1.coralogix.com/mgmt/openapi/5
  • URL: https://api.eu1.coralogix.com/mgmt/openapi/5/alerts/alerts/v3
  • Auth: API key in header Authorization

Query parameters

Filter to apply to the list of alert definitions

{
  "idFilter": {
    "alertId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  },
  "typeSpecificFilter": {
    "sloFilter": {
      "sloId": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  }
}
pageSizeinteger

Page size.

pageTokenstring

The page token.

Pagination settings for the list of alert definitions

Ordering settings for the list of alert definitions

include_access_permissionsboolean

When true, populate the response's per-alert access map with the caller's access decision and each alert's raw access policy. Defaults to false.

Response

accessobject

The caller's access decision and raw access policy per alert, keyed by alert definition ID

Changes

No recorded changes to this operation across all 1 revision of this API.