Dell Servers Alerts API

openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Alerts API
  description: Integrated Dell Remote Access Controller (iDRAC) RESTful API built upon the DMTF Redfish standard for out-of-band server lifecycle management of Dell PowerEdge servers. Provides programmatic access to server inventory, health monitoring, configuration, firmware updates, power control, virtual media, and BIOS management through a standards-based REST interface.
  version: '5.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://{idrac-ip}/redfish/v1
  description: iDRAC Redfish Service Root
  variables:
    idrac-ip:
      description: IP address or hostname of the iDRAC interface
      default: 192.168.1.100
security:
- basicAuth: []
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:
  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
  parameters:
    AlertId:
      name: AlertId
      in: path
      required: true
      description: Unique identifier for an alert
      schema:
        type: integer
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using iDRAC username and password credentials. All API requests require authentication except for the Redfish service root at /redfish/v1.
    sessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session-based authentication using a token obtained from the Sessions resource POST operation. The token is passed in the X-Auth-Token header.
externalDocs:
  description: iDRAC Redfish API Documentation
  url: https://developer.dell.com/apis/2978/versions/5.xx/docs/1.0Intro.md