HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. alarm

Get Orchestrator and appliance alarm descriptions

get
http://127.0.0.1:8080/alarm/description2

Retrieves a collection of alarm descriptions including severity, recommended actions, and metadata. Replaces the deprecated /alarm/description endpoint. Can return default or customized alarm configurations and supports CSV export for reporting.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Output format for the alarm descriptions. Use 'csv' to download as a CSV file.

Allowed:
boolean
Defaults to true

Controls which alarm configuration to return. When true or omitted, returns default alarm descriptions. When false, returns customized alarm descriptions with user modifications.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.ms-excel

Updated about 11 hours ago

Did this page help you?