Super Micro Computer

Super Micro Computer Update Service API

Firmware and BIOS update management

GitHub OpenAPI

Operations 3

GET /UpdateService Get Update Service #
GET /UpdateService/FirmwareInventory List Firmware Inventory #
POST /UpdateService/Actions/UpdateService.SimpleUpdate Perform Simple Firmware Update #

Documentation

📖
Documentation
https://www.supermicro.com/manuals/other/redfish-ref-guide-html/Content/general-content/introduction.htm
📖
Documentation
https://www.supermicro.com/manuals/other/RedfishUserGuide.pdf

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/super-micro-computer/refs/heads/main/openapi/super-micro-computer-update-service-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/supermicro/redfish

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/super-micro-computer/refs/heads/main/json-schema/supermicro-computer-system-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/super-micro-computer/refs/heads/main/json-structure/supermicro-computer-system-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/super-micro-computer/refs/heads/main/json-ld/super-micro-computer-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/super-micro-computer/refs/heads/main/rules/supermicro-redfish-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/super-micro-computer/refs/heads/main/vocabulary/super-micro-computer-vocabulary.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/super-micro-computer-update-service-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

super-micro-computer-update-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Supermicro Redfish Accounts Update Service API
  description: Supermicro's implementation of the DMTF Redfish RESTful API standard for out-of-band server management via BMC (Baseboard Management Controller). Provides programmatic access to server health monitoring, power management, BIOS/BMC firmware updates, storage configuration, network configuration, user account management, and event logging across Supermicro server platforms (X10 and later Intel-based, H11 and later AMD-based platforms).
  version: '1.0'
  contact:
    name: Supermicro Support
    url: https://www.supermicro.com/en/support
    email: support@supermicro.com
  license:
    name: Proprietary
    url: https://www.supermicro.com/en/solutions/management-software/redfish
servers:
- url: https://{bmc-ip}/redfish/v1
  description: Supermicro BMC Redfish endpoint
  variables:
    bmc-ip:
      description: IP address or hostname of the BMC
      default: 192.168.1.100
security:
- BasicAuth: []
- SessionAuth: []
tags:
- name: Update Service
  description: Firmware and BIOS update management
paths:
  /UpdateService:
    get:
      operationId: getUpdateService
      summary: Get Update Service
      description: Returns the firmware update service resource.
      tags:
      - Update Service
      responses:
        '200':
          description: Update service resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateService'
  /UpdateService/FirmwareInventory:
    get:
      operationId: listFirmwareInventory
      summary: List Firmware Inventory
      description: Returns the current firmware inventory for all managed components.
      tags:
      - Update Service
      responses:
        '200':
          description: Firmware inventory collection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
  /UpdateService/Actions/UpdateService.SimpleUpdate:
    post:
      operationId: simpleUpdate
      summary: Perform Simple Firmware Update
      description: Initiates a firmware update for a target component using a specified firmware image URI.
      tags:
      - Update Service
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimpleUpdateAction'
      responses:
        '200':
          description: Update initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActionResponse'
components:
  schemas:
    UpdateService:
      type: object
      description: The firmware update service
      properties:
        '@odata.type':
          type: string
        Id:
          type: string
        Name:
          type: string
        Status:
          $ref: '#/components/schemas/Status'
        FirmwareInventory:
          $ref: '#/components/schemas/ODataId'
    ActionResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
    Status:
      type: object
      description: Health and operational status
      properties:
        State:
          type: string
          enum:
          - Enabled
          - Disabled
          - StandbyOffline
          - StandbySpare
          - InTest
          - Starting
          - Absent
          - UnavailableOffline
          - Deferring
          - Quiescing
          - Updating
        Health:
          type: string
          enum:
          - OK
          - Warning
          - Critical
        HealthRollup:
          type: string
          enum:
          - OK
          - Warning
          - Critical
    Collection:
      type: object
      description: A collection of resources with navigation links
      properties:
        '@odata.type':
          type: string
        Name:
          type: string
        Members@odata.count:
          type: integer
        Members:
          type: array
          items:
            $ref: '#/components/schemas/ODataId'
    ODataId:
      type: object
      properties:
        '@odata.id':
          type: string
          description: OData link to the resource
    SimpleUpdateAction:
      type: object
      required:
      - ImageURI
      - Targets
      properties:
        ImageURI:
          type: string
          format: uri
          description: URI of the firmware image to install
        Targets:
          type: array
          items:
            type: string
          description: Target component IDs to update
        TransferProtocol:
          type: string
          enum:
          - TFTP
          - HTTPS
          - HTTP
          - SCP
          - SFTP
          - FTP
          - NSF
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using BMC username and password
    SessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Redfish session token obtained from POST /redfish/v1/SessionService/Sessions