Policies
List Notification policies
client.alerting.policies.list(PolicyListParams { account_id } params, RequestOptionsoptions?): SinglePage<Policy { id, alert_interval, alert_type, 7 more } >
GET/accounts/{account_id}/alerting/v3/policies
Get a Notification policy
client.alerting.policies.get(stringpolicyId, PolicyGetParams { account_id } params, RequestOptionsoptions?): Policy { id, alert_interval, alert_type, 7 more }
GET/accounts/{account_id}/alerting/v3/policies/{policy_id}
Create a Notification policy
client.alerting.policies.create(PolicyCreateParams { account_id, alert_type, enabled, 5 more } params, RequestOptionsoptions?): PolicyCreateResponse { id }
POST/accounts/{account_id}/alerting/v3/policies
Update a Notification policy
client.alerting.policies.update(stringpolicyId, PolicyUpdateParams { account_id, alert_interval, alert_type, 5 more } params, RequestOptionsoptions?): PolicyUpdateResponse { id }
PUT/accounts/{account_id}/alerting/v3/policies/{policy_id}
Delete a Notification policy
client.alerting.policies.delete(stringpolicyId, PolicyDeleteParams { account_id } params, RequestOptionsoptions?): PolicyDeleteResponse { errors, messages, success, result_info }
DELETE/accounts/{account_id}/alerting/v3/policies/{policy_id}
ModelsExpand Collapse
Policy { id, alert_interval, alert_type, 7 more }
Policy { id, alert_interval, alert_type, 7 more }
alert_interval?: string
Optional specification of how often to re-alert from the same incident, not support on all alert types.
alert_type?: "abuse_report_alert" | "access_custom_certificate_expiration_type" | "advanced_ddos_attack_l4_alert" | 66 moreRefers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.
alert_type?: "abuse_report_alert" | "access_custom_certificate_expiration_type" | "advanced_ddos_attack_l4_alert" | 66 more
Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.
One of the following:
Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
PolicyFilter { actions, affected_asns, affected_components, 40 more } Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
PolicyFilter { actions, affected_asns, affected_components, 40 more }
Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.