Get alert definition by ID

GEThttps://api.coralogix.com/mgmt/openapi/5/alerts/alerts/v3/{id}

Returns the details of the specified alert definition.

Requires the following permissions:

• alerts:ReadConfig

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

id# stringrequired
Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Alert definition ID
Example: 123e4567-e89b-12d3-a456-426614174000

Query Parameters

include_access_permissions# boolean

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

Response

200400401500application/json

A response containing the requested alert definition

access# object
The caller's access decision and the alert's raw access policy
alertDef# object
The requested alert definition