Dell Servers Event Service API

openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Event Service 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: Event Service
  description: Event subscriptions and server-sent events configuration
paths:
  /EventService:
    get:
      operationId: getEventService
      summary: Dell Servers Get event service
      description: Retrieves the event service resource which provides configuration for event subscriptions and server-sent events. The event service enables clients to subscribe to alerts and lifecycle events from the iDRAC.
      tags:
      - Event Service
      responses:
        '200':
          description: Event service resource
          content:
            application/json:
              schema:
                type: object
                description: Event service configuration
        '401':
          description: Unauthorized - invalid or missing credentials
  /EventService/Subscriptions:
    get:
      operationId: listEventSubscriptions
      summary: Dell Servers List event subscriptions
      description: Retrieves the collection of event subscriptions configured on the iDRAC. Each subscription defines a destination URL and event types to which the client has subscribed for receiving push notifications.
      tags:
      - Event Service
      responses:
        '200':
          description: Collection of event subscriptions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
        '401':
          description: Unauthorized - invalid or missing credentials
    post:
      operationId: createEventSubscription
      summary: Dell Servers Create an event subscription
      description: Creates a new event subscription that configures the iDRAC to push event notifications to a specified destination URL when events matching the subscription criteria occur. iDRAC supports up to eight concurrent subscriptions.
      tags:
      - Event Service
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventSubscription'
      responses:
        '201':
          description: Event subscription created
        '400':
          description: Invalid subscription parameters
        '401':
          description: Unauthorized - invalid or missing credentials
components:
  schemas:
    EventSubscription:
      type: object
      description: Event subscription request for push notifications
      required:
      - Destination
      - EventTypes
      - Protocol
      properties:
        Destination:
          type: string
          format: uri
          description: URL to which events will be posted
        EventTypes:
          type: array
          description: Types of events to subscribe to
          items:
            type: string
            enum:
            - StatusChange
            - ResourceUpdated
            - ResourceAdded
            - ResourceRemoved
            - Alert
            - MetricReport
        Protocol:
          type: string
          description: Protocol for event delivery
          enum:
          - Redfish
        Context:
          type: string
          description: Client-supplied context string returned with events
    ResourceCollection:
      type: object
      description: Redfish resource collection
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        '@odata.type':
          type: string
          description: OData resource type
        Name:
          type: string
          description: Collection name
        Members@odata.count:
          type: integer
          description: Number of members in the collection
        Members:
          type: array
          description: Array of resource links
          items:
            $ref: '#/components/schemas/ResourceLink'
    ResourceLink:
      type: object
      description: Link to a Redfish resource
      properties:
        '@odata.id':
          type: string
          description: OData resource URI
  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