openapi: 3.1.0
info:
  title: Vertiv Environet Alert REST Alarms Sensors 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: Sensors
paths:
  /sensors:
    get:
      operationId: listSensors
      summary: List All Sensor Points
      description: Returns all sensor data points (POINT entities) in the Environet Alert system, including temperature, humidity, airflow, door position, and leak detection sensor readings.
      tags:
      - Sensors
      security:
      - sessionToken: []
      parameters:
      - name: deviceName
        in: query
        required: false
        description: Filter by parent device name
        schema:
          type: string
      - name: siteName
        in: query
        required: false
        description: Filter by site name
        schema:
          type: string
      responses:
        '200':
          description: List of sensor points
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Sensor'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Sensor:
      type: object
      description: A sensor data point in the Environet system
      properties:
        sensorId:
          type: string
          description: Unique sensor identifier
        sensorName:
          type: string
          description: Sensor display name
        deviceName:
          type: string
          description: Parent device name
        siteName:
          type: string
          description: Site location
        sensorType:
          type: string
          description: Type of sensor (temperature, humidity, etc.)
        value:
          type: number
          format: float
          description: Current sensor reading value
        unit:
          type: string
          description: Unit of measurement (C, F, %, etc.)
        status:
          type: string
          description: Sensor status
          enum:
          - NORMAL
          - ALARM
          - WARNING
          - UNKNOWN
        lastUpdated:
          type: string
          format: date-time
          description: Timestamp of last reading
    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
  securitySchemes:
    sessionToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session token obtained from the /auth endpoint