openapi: 3.1.0
info:
  title: Vertiv Environet Alert REST Alarms Data Sets 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: Data Sets
paths:
  /datasets:
    get:
      operationId: listDatasets
      summary: List All Data Sets
      description: Returns the top-level list of data set entities available in the Environet Alert system. Each data set entity represents a category of infrastructure data such as groups, locations, racks, assets, devices, circuits, and points.
      tags:
      - Data Sets
      security:
      - sessionToken: []
      responses:
        '200':
          description: List of data set entities
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataSetEntity'
        '401':
          description: Unauthorized - missing or invalid session token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /datasets/{category}:
    get:
      operationId: getDatasetByCategory
      summary: Get Data Set by Category
      description: Returns entities for a specific data category. Supported categories include GROUP, LOCATION, RACK, ASSET, DEVICE, CIRCUIT, POINT, Tenant, Maintenance, and ALARM.
      tags:
      - Data Sets
      security:
      - sessionToken: []
      parameters:
      - name: category
        in: path
        required: true
        description: The data set category to retrieve
        schema:
          type: string
          enum:
          - GROUP
          - LOCATION
          - RACK
          - ASSET
          - DEVICE
          - CIRCUIT
          - POINT
          - Tenant
          - Maintenance
          - ALARM
      responses:
        '200':
          description: Data set entities for the specified category
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSetEntity'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Category not found
          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
    StatusSummary:
      type: object
      description: Status summary with alarm and event counts
      properties:
        overall:
          type: string
          description: Overall status value
          enum:
          - NORMAL
          - ALARM
          - WARNING
          - DOWN
          - MAINTENANCE
          - DISABLED
          - FAULT
          - UNKNOWN
        alarmCount:
          type: integer
          description: Number of active alarms
        warningCount:
          type: integer
          description: Number of active warnings
        infoCount:
          type: integer
          description: Number of informational events
        downCount:
          type: integer
          description: Number of down devices/points
        faultCount:
          type: integer
          description: Number of faults
        maintenanceCount:
          type: integer
          description: Number of items in maintenance mode
        disabledCount:
          type: integer
          description: Number of disabled items
        normalCount:
          type: integer
          description: Number of items in normal state
        unknownCount:
          type: integer
          description: Number of items in unknown state
    DataSetEntity:
      type: object
      description: A top-level data set entity representing a category of infrastructure data
      properties:
        category:
          type: string
          description: Data category identifier
          enum:
          - GROUP
          - LOCATION
          - RACK
          - ASSET
          - DEVICE
          - CIRCUIT
          - POINT
          - Tenant
          - Maintenance
          - ALARM
        categoryId:
          type: string
          description: Unique category ID
        displayName:
          type: string
          description: Human-readable display name
        path:
          type: string
          description: Hierarchical path in the Environet system
        status:
          $ref: '#/components/schemas/StatusSummary'
        links:
          type: array
          description: Related resource links
          items:
            type: object
            properties:
              rel:
                type: string
              href:
                type: string
        entries:
          type: array
          description: Child entities within this category
          items:
            type: object
  securitySchemes:
    sessionToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session token obtained from the /auth endpoint