We are currently transitioning our API documentation to Apidog and making changes to improve standardization, and as such, methods are subject to change.
Units for expiration_time parameter. Can be second (default), minute, hour, day, or week. Example: minute.
expiration_time
stringÂ
optional
Expiration time for alerts, specified in units as per expiration_time_unit. Defaults to 3600. Example: 3.
alert_email_recipient_ids
stringÂ
optional
Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.
alert_sms_recipient_ids
stringÂ
optional
Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.
mention_slack_recipient_ids
stringÂ
optional
Comma-separated list of user ids to be mentioned in Slack alerts. Example: 101,102.
summary_report_schedule
stringÂ
optional
When to send summary reports. Valid example values are daily-10:00, weekly-monday, monthly-17. If this is not set, summary reports are not enabled. Example: daily-10:00.
summary_report_recipient_ids
stringÂ
optional
Comma-separated list of user ids to receive summary reports by email. If 'summary_report_frequency' has been specified, at least one user id must be specified here. Example: 101,102.
send_test_alert
stringÂ
optional
"true" or "false", whether to fire a test alert when the watcher is created. Example: true.
Body Params application/x-www-form-urlencoded
chips
stringÂ
required
Comma-separated list of chips to create the watcher with. Example: cpu,idle.
alert
stringÂ
optional
Boolean: Whether the watcher should be configured to alert. Defaults to false if not specified. Example: true.
name
stringÂ
required
A name for the watcher. Example: My Brand New Watcher.
alert_slack_channel
stringÂ
optional
A slack channel to alert to. Example: anomify-alerts.
Units for expiration_time parameter. Can be second (default), minute, hour, day, or week. Example: minute.
expiration_time
stringÂ
optional
Expiration time for alerts, specified in units as per expiration_time_unit. Defaults to 3600. Example: 3. Must be a minimum of 900 seconds (15 minutes) when the expiration_time_unit is taken into account.
alert_email_recipient_ids
stringÂ
optional
Comma-separated list of user ids to receive real-time alerts by email. Example: 101,102.
alert_sms_recipient_ids
stringÂ
optional
Comma-separated list of user ids to receive real-time alerts by SMS. Example: 101,102.
mention_slack_recipient_ids
stringÂ
optional
Comma-separated list of user ids to be mentioned in Slack alerts. Example: 101,102.
summary_report_schedule
stringÂ
optional
When to send summary reports. Valid example values are daily-10:00, weekly-monday, monthly-17. If this is not set, summary reports are not enabled. Example: daily-10:00.
summary_report_recipient_ids
stringÂ
optional
Comma-separated list of user ids to receive summary reports by email. If 'summary_report_frequency' has been specified, at least one user id must be specified here. Example: 101,102.
send_test_alert
stringÂ
optional
"true" or "false", whether to fire a test alert when the watcher is created. Example: true.