OpenBMC

OpenBMC is a Linux Foundation project producing an open source implementation of baseboard management controller firmware. Founded by Microsoft, Intel, IBM, Google, and Facebook, it provides a Linux-based firmware stack for managing and monitoring server hardware systems.

1 APIs 0 Features

FirmwareHardwareLinux FoundationServer

APIs

OpenBMC API

API for interacting with OpenBMC baseboard management controller firmware, providing programmatic access to server hardware management and monitoring capabilities.

Collections

OpenBMC Redfish API

OPEN

Pricing Plans

Openbmc Plans Pricing

3 plans

PLANS

Rate Limits

Openbmc Rate Limits

5 limits

RATE LIMITS

FinOps

Openbmc Finops

FINOPS

Resources

Sources

opencollection: 1.0.0
info:
  name: OpenBMC Redfish API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: X-Auth-Token
    value: '{{X-Auth-Token}}'
    placement: header
items:
- info:
    name: Get Redfish service root
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/
  docs: Returns the Redfish service root document describing top-level collections and capabilities.
- info:
    name: Create a Redfish session
    type: http
  http:
    method: POST
    url: https://{bmc}/redfish/v1/SessionService/Sessions
    body:
      type: json
      data: '{}'
  docs: Authenticates a user and creates a session. The X-Auth-Token response header value must be sent on subsequent requests.
- info:
    name: List chassis objects
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/Chassis
  docs: List chassis objects
- info:
    name: List manager objects
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/Managers
  docs: List manager objects
- info:
    name: List system objects
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/Systems
  docs: List system objects
- info:
    name: Reset host computer system
    type: http
  http:
    method: POST
    url: https://{bmc}/redfish/v1/Systems/system/Actions/ComputerSystem.Reset
    body:
      type: json
      data: '{}'
  docs: Controls host power by issuing a ComputerSystem.Reset action.
- info:
    name: Reboot the BMC
    type: http
  http:
    method: POST
    url: https://{bmc}/redfish/v1/Managers/bmc/Actions/Manager.Reset
    body:
      type: json
      data: '{}'
  docs: Reboot the BMC
- info:
    name: Factory reset the BMC
    type: http
  http:
    method: POST
    url: https://{bmc}/redfish/v1/Managers/bmc/Actions/Manager.ResetToDefaults
    body:
      type: json
      data: '{}'
  docs: Factory reset the BMC
- info:
    name: Get system event log entries
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/Systems/system/LogServices/EventLog/Entries
  docs: Get system event log entries
- info:
    name: Get firmware update service
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/UpdateService
  docs: Get firmware update service
- info:
    name: Update the root account
    type: http
  http:
    method: PATCH
    url: https://{bmc}/redfish/v1/AccountService/Accounts/root
    body:
      type: json
      data: '{}'
  docs: Modifies the root account, for example to change the password.
- info:
    name: List event subscriptions
    type: http
  http:
    method: GET
    url: https://{bmc}/redfish/v1/EventService/Subscriptions
  docs: List event subscriptions
- info:
    name: Create an event subscription
    type: http
  http:
    method: POST
    url: https://{bmc}/redfish/v1/EventService/Subscriptions
    body:
      type: json
      data: '{}'
  docs: Create an event subscription
bundled: true