Toggle alert rule

post

https://example.com/api/v1/alerts/rules/{id}/toggle/

Enable or disable an alert rule

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

A unique integer value identifying this alert rule.

Body Params

Response for alert rule.

name

string

required

length between 1 and 100

operator

string

enum

eq - Equals
neq - Not Equals
lt - Less Than
le - Less Than or Equal
gt - Greater Than
ge - Greater Than or Equal
contains - Contains
startswith - Starts With
endswith - Ends With
regex - Regex Match

value

string | null

conditions

string

description

string | null

enabled

boolean

priority

string

enum

info - Info
warning - Warning
critical - Critical

Allowed:

starts_at

date-time | null

expires_at

date-time | null

api_url

string | null

cooldown_minutes

integer

-2147483648 to 2147483647

last_triggered

date-time | null

visibility

string

enum

private - Private
shared - Shared
public - Public

Allowed:

is_system

boolean

System rules cannot be deleted by users

suppression_windows

string

Time windows when this rule should not trigger. Format: [{"day": "saturday", "start": "22:00", "end": "08:00"}]

use_global_notifications

boolean

Also send to global notification URLs from environment

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200