alert.list_categories

List all types of alerts which the system can issue.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: options

options

Type: object

Default:

{ "include_all_products": false, "include_hidden_classes": false }

List options.

No Additional Properties

include_all_products

Include All Products

Type: boolean Default: false

Include alert classes for all products, not just the current one.

include_hidden_classes

Include Hidden Classes

Type: boolean Default: false

Include hidden alert classes.

Return value

Result

Type: array of object

Array of available alert categories and their classes.

No Additional Items

Each item of this array must be:

AlertCategory

Type: object
No Additional Properties

id Required

Id

Type: string

Unique identifier for the alert category.

title Required

Title

Type: string

Human-readable title for the alert category.

classes Required

Classes

Type: array of object

Array of alert classes within this category.

No Additional Items

Each item of this array must be:

AlertCategoryClass

Type: object
No Additional Properties

id Required

Id

Type: string

Unique identifier for the alert class.

title Required

Title

Type: string

Human-readable title for the alert class.

level Required

Level

Type: string

Default severity level for alerts in this class.

product_types Required

Product Types

Type: array of enum (of string)

Product types where this alert class is available.

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

• "COMMUNITY_EDITION"
• "ENTERPRISE"

proactive_support Required

Proactive Support

Type: boolean

Whether this alert class is included in proactive support monitoring.

Required roles: ALERT_LIST_READ