API Reference

Alerting

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Available Alerts

Get Alert Types

client.alerting.availableAlerts.list(AvailableAlertListParams { account_id } params, RequestOptionsoptions?): AvailableAlertListResponse { description, display_name, filter_options, type }

GET/accounts/{account_id}/alerting/v3/available_alerts

ModelsExpand Collapse

AvailableAlertListResponse = Record<string, Array<Item>>

description?: string

Describes the alert type.

display_name?: string

Alert type name.

filter_options?: Array<unknown>

Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.

type?: string

Use this value when creating and updating a notification policy.