Actions60
- Alarm Actions
- Asset Actions
- Customer Actions
- Dashboard Actions
- Device Actions
- Entity Group Actions
- Relation Actions
- Telemetry Actions
Alarm → Get Types
AI-generatedSummary
List alarm types with optional filters and pagination
Inputs
- authentication (required) — Authentication method: API Key or Username / Password
- pageSize — Maximum number of entities per page (default 10, min 1)
- page — Page number (default 0, zero‑based)
- sortOrder — Sort direction, either ASC or DESC (default DESC)
- alarmSortProperty — Property used for sorting (default createdTime)
- alarmTextSearch — Case‑insensitive substring filter on alarm type, severity, or status
Output shape
an array of alarm type objects
Paginated results; defaults pageSize=10 and page=0; sorting uses alarmSortProperty and sortOrder; optional alarmTextSearch filters by type, severity, or status
Examples
Example 1: Retrieve all alarm types using default settings
Authentication set to API Key; leave pageSize, page, sortOrder, alarmSortProperty, and alarmTextSearch at their defaults
Example 2: Search alarm types containing 'CRITICAL'
Authentication set to API Key; enable alarmTextSearch with value 'CRITICAL'; optionally set alarmSortProperty to 'severity' and sortOrder to 'ASC'
Example 3: Fetch the second page of results
Authentication set to API Key; set page to 1 and pageSize to 20; keep other defaults