openapi: 3.2.0
info:
  title: OpenBMC Redfish Event Service API
  description: OpenBMC exposes a Redfish-conformant REST API over HTTPS for managing server baseboard management controllers (BMCs). The API provides programmatic access to chassis, manager, system, power, log, event, and update services. Authentication is performed via a session token returned from the SessionService and supplied in the X-Auth-Token header on subsequent requests. This OpenAPI definition reflects the endpoints documented in the OpenBMC Redfish cheatsheet.
  version: 1.0.0
  contact:
    name: OpenBMC Documentation
    url: https://github.com/openbmc/docs
servers:
- url: https://{bmc}/redfish/v1
  description: OpenBMC Redfish service root on a BMC host
  variables:
    bmc:
      default: bmc.example.com
      description: Hostname or IP address of the OpenBMC-managed BMC
security:
- SessionToken: []
tags:
- name: Event Service
paths:
  /EventService/Subscriptions:
    get:
      summary: List event subscriptions
      operationId: listEventSubscriptions
      responses:
        '200':
          description: Event subscriptions collection
          content:
            application/json:
              schema:
                type: object
      tags:
      - Event Service
    post:
      summary: Create an event subscription
      operationId: createEventSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Destination:
                  type: string
                EventTypes:
                  type: array
                  items:
                    type: string
                Context:
                  type: string
                Protocol:
                  type: string
      responses:
        '201':
          description: Subscription created
      tags:
      - Event Service
components:
  securitySchemes:
    SessionToken:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Redfish session token obtained from POST /SessionService/Sessions