API

Create an alert definition

post
https://api.linode.com//monitor/services//alert-definitions

Limited availability Create a new alert definition for a specific service type. Akamai refers to these as user alerts. Run the List supported service types operation to see a list of services.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: monitor:read_write

CLI

linode-cli alerts definition-create \
--channel_ids 546 \
--label CPU usage threshold maximum \
--rule_criteria.metric cpu_usage \
--rule_criteria.operator gt \
--rule_criteria.threshold 80 \
--severity 2
--trigger_conditions.evaluation_period_seconds 300 \
--trigger_conditions.polling_interval_seconds 300 \
--trigger_conditions.trigger_occurrences 3 \

Learn more

Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
string
required

The Akamai Cloud Computing service being monitored. To see your currently supported services, run the List supported service types operation and store the appropriate service_type.

Body Params

The fields used to create an alert definition with a scope of account.

channel_ids
array of integers
required

The identifiers for the notification channels to use for the alert. Run the List notification channels operation and store the id for the applicable channels.

channel_ids*
string

An additional description for the alert definition.

group_by
array of strings

Aggregates metric data by dimension so that alert conditions are evaluated independently for each dimension value. For example, if you group CPU usage by node type, CPU usage is evaluated separately for each node type, instead of evaluating all node types together. This array supports these values:

  • entity_id. Include this by name to group the alerts using the entity_id.

  • dimension_label. This represents the desired dimension from a monitoring metric. To get a dimension_label, run the List metrics for a service type operation, review the available dimensions, and store the applicable dimension_label values.

The entity_id is required if you include any dimension_label, to specify the service that the dimension_label belongs to. If you leave group_by out the request, the alert definition is evaluated and grouped by the entity_id.

📘

The entity_id is not mandatory if the service_type is objectstorage.

group_by
string
required

The name of the alert definition. This is used for display purposes in Akamai Cloud Manager.

rule_criteria
object
required

Details for the rules required to trigger the alert.

string
enum
required

The classification of the alert definition, describing where it applies. For this model, set this to account to set the alert for all of the specified serviceType entities on your account.

📘

Currently, alerts are available for limited services (serviceType), in specific regions. Talk to your account manager or reach out to our sales team for more information.

Allowed:
integer
enum
required

The severity of the alert. Supported values include 3 for info, 2 for low, 1 for medium, and 0 for severe.

Allowed:
trigger_conditions
object
required

The conditions that need to be met to send a notification for the alert.

Responses

Updated 24 days ago

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json

Updated 24 days ago