openapi: 3.1.0
info:
  title: Vertiv Environet Alert REST Alarms API
  description: The Vertiv Environet Alert Public REST API provides programmatic access to Vertiv's DCIM monitoring platform. The API enables retrieval of device data, sensor readings, environmental metrics, alerts, alarms, circuit information, rack details, and asset management data from data center environments. The API is designed for integration with third-party DCIM platforms, ITSM tools, and custom automation workflows.
  version: 2.0.0
  contact:
    name: Vertiv Support
    url: https://www.vertiv.com/en-us/support/
  license:
    name: Proprietary
    url: https://www.vertiv.com/
servers:
- url: https://{environet-host}/api
  description: Vertiv Environet Alert instance
  variables:
    environet-host:
      default: localhost
      description: Hostname or IP address of the Environet Alert installation
tags:
- name: Alarms
paths:
  /alarms:
    get:
      operationId: listAlarms
      summary: List Active Alarms
      description: Returns all active alarms in the Environet Alert system. Includes alarm severity, source device, timestamp, and alarm details.
      tags:
      - Alarms
      security:
      - sessionToken: []
      parameters:
      - name: severity
        in: query
        required: false
        description: Filter alarms by severity level
        schema:
          type: string
          enum:
          - ALARM
          - WARNING
          - INFO
      - name: alarmSource
        in: query
        required: false
        description: Filter by alarm source device or asset name
        schema:
          type: string
      - name: siteName
        in: query
        required: false
        description: Filter by site name
        schema:
          type: string
      responses:
        '200':
          description: List of active alarms
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Alarm'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      description: Error response
      properties:
        code:
          type: integer
          description: HTTP error code
        message:
          type: string
          description: Error message
        details:
          type: string
          description: Additional error details
    Alarm:
      type: object
      description: An active alarm in the Environet Alert system
      properties:
        alarmId:
          type: string
          description: Unique alarm identifier
        alarmSource:
          type: string
          description: Source device or asset generating the alarm
        severity:
          type: string
          description: Alarm severity level
          enum:
          - ALARM
          - WARNING
          - INFO
        message:
          type: string
          description: Alarm message text
        timestamp:
          type: string
          format: date-time
          description: Alarm occurrence timestamp
        siteName:
          type: string
          description: Site where the alarm originated
        acknowledged:
          type: boolean
          description: Whether the alarm has been acknowledged
  securitySchemes:
    sessionToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session token obtained from the /auth endpoint