Update an alert definition

Limited availability Update an existing alert definition. You need read_only access to the OAuth scope for the selected serviceType. Only include the objects in the request that you want to update. Leave any object out of the request to leave it set as is.

When updating an alert definition you've created, you can change the status to enabled or disabled. You can also modify the label, description, and severity. You can't update a scope, but you can update its applicable entity_ids or regions, as well as its rule_criteria, trigger_conditions, and channel_ids objects. If updating the rule_criteria, channel_ids, entity_ids, or regions fields, these points apply:

  • If you want to keep an existing item, you need to include it in the list.

  • If you want to remove an existing item, leave it out of the list.

  • To add a new item, include it in the list.

  • You can't pass an empty list to remove all items. This doesn't apply to the entity_ids, regions, or dimension_filters (in rule_criteria) list objects, because they are optional, while all other list objects are required.

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-update dbaas 457 \
--status disabled \
--label Read-Write Channel (old)

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.

integer
required

The unique identifier assigned to the alert definition. Run the List alert definitions operation and store the id for the applicable one.

Body Params

The fields used to update an alert definition that uses a scope of account. (You can't update an alert definition's scope.)

channel_ids
array of integers

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

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

rule_criteria
object

Details for the rules required to trigger the alert.

integer
enum

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

Allowed:
string
enum

The accessibility status of the alert definition. When updating, you can set this to enabled or disabled.

Allowed:
trigger_conditions
object

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

Responses

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