Dell Servers Alerts API

openapi: 3.2.0
info:
  title: Dell Servers Dell OpenManage Enterprise Alerts API
  description: RESTful API for centralized management of Dell EMC servers, chassis, and storage through the OpenManage Enterprise console. Provides discovery, inventory, monitoring, alerting, firmware updates, configuration compliance, and lifecycle management of Dell PowerEdge infrastructure at scale. The API delivers JSON responses over HTTPS and follows OData v4 conventions.
  version: '4.0'
  contact:
    name: Dell Technologies Support
    url: https://www.dell.com/support
  termsOfService: https://i.dell.com/sites/csdocuments/Legal_Docs/en/us/api-terms-of-use_en.pdf
servers:
- url: https://{ome-server}/api
  description: OpenManage Enterprise API Server
  variables:
    ome-server:
      description: Hostname or IP address of the OpenManage Enterprise appliance
      default: ome-server.example.com
security:
- sessionAuth: []
tags:
- name: Alerts
  description: Alert monitoring, acknowledgment, and management
paths:
  /AlertService/Alerts:
    get:
      operationId: listAlerts
      summary: Dell Servers List alerts
      description: Retrieves the collection of alerts generated by managed devices. Alerts include hardware faults, threshold violations, configuration changes, and audit events. Supports OData filtering and pagination.
      tags:
      - Alerts
      parameters:
      - name: $top
        in: query
        description: Maximum number of alerts to return
        schema:
          type: integer
          default: 25
      - name: $skip
        in: query
        description: Number of alerts to skip for pagination
        schema:
          type: integer
          default: 0
      - name: $filter
        in: query
        description: OData filter expression for alert criteria
        schema:
          type: string
      - name: $orderby
        in: query
        description: Property name to sort results by
        schema:
          type: string
      responses:
        '200':
          description: Collection of alerts
          content:
            application/json:
              schema:
                type: object
                properties:
                  '@odata.count':
                    type: integer
                    description: Total number of matching alerts
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alert'
        '401':
          description: Unauthorized - invalid or expired session token
  /AlertService/Alerts({AlertId}):
    get:
      operationId: getAlert
      summary: Dell Servers Get an alert
      description: Retrieves detailed information about a specific alert including the source device, severity, category, message, and recommended actions.
      tags:
      - Alerts
      parameters:
      - $ref: '#/components/parameters/AlertId'
      responses:
        '200':
          description: Alert details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
        '401':
          description: Unauthorized - invalid or expired session token
        '404':
          description: Alert not found
components:
  parameters:
    AlertId:
      name: AlertId
      in: path
      required: true
      description: Unique identifier for an alert
      schema:
        type: integer
  schemas:
    Alert:
      type: object
      description: An alert generated by a managed device
      properties:
        Id:
          type: integer
          description: Unique alert identifier
        AlertDeviceId:
          type: integer
          description: Device that generated the alert
        AlertDeviceName:
          type: string
          description: Name of the device that generated the alert
        AlertDeviceIpAddress:
          type: string
          description: IP address of the device
        SeverityType:
          type: integer
          description: Alert severity code. 1 is informational, 2 is normal, 4 is warning, 8 is critical, 16 is unknown.
        StatusType:
          type: integer
          description: Alert acknowledgment status. 1000 is new, 2000 is acknowledged.
        CategoryName:
          type: string
          description: Alert category name
        SubCategoryName:
          type: string
          description: Alert subcategory name
        Message:
          type: string
          description: Alert message text
        TimeStamp:
          type: string
          format: date-time
          description: Timestamp when the alert was generated
        RecommendedAction:
          type: string
          description: Recommended action to resolve the alert
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session token obtained from the POST /SessionService/Sessions endpoint. Must be included in the X-Auth-Token header of all authenticated requests.
externalDocs:
  description: OpenManage Enterprise RESTful API Guide
  url: https://www.dell.com/support/manuals/en-us/dell-openmanage-enterprise/ome_p_api_guide/overview?guid=guid-fc1c0585-795c-41fe-9957-977678be554f&lang=en-us