Dell Servers Firmware API

openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Firmware 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: Firmware
  description: Firmware catalog management, compliance, and update operations
paths:
  /UpdateService/Catalogs:
    get:
      operationId: listFirmwareCatalogs
      summary: Dell Servers List firmware catalogs
      description: Retrieves the collection of firmware catalogs registered in OpenManage Enterprise. Catalogs contain firmware packages from Dell support sites or custom repositories used for compliance checking and updates.
      tags:
      - Firmware
      responses:
        '200':
          description: Collection of firmware catalogs
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/FirmwareCatalog'
        '401':
          description: Unauthorized - invalid or expired session token
  /UpdateService/Actions/UpdateService.GetBaselines:
    post:
      operationId: getFirmwareBaselines
      summary: Dell Servers Get firmware compliance baselines
      description: Retrieves firmware compliance baselines that define the expected firmware versions for devices. Baselines are used to check device compliance and identify devices needing firmware updates.
      tags:
      - Firmware
      responses:
        '200':
          description: Firmware compliance baselines
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/FirmwareBaseline'
        '401':
          description: Unauthorized - invalid or expired session token
components:
  schemas:
    FirmwareBaseline:
      type: object
      description: A firmware compliance baseline
      properties:
        Id:
          type: integer
          description: Unique baseline identifier
        Name:
          type: string
          description: Baseline name
        Description:
          type: string
          description: Baseline description
        CatalogId:
          type: integer
          description: Associated firmware catalog identifier
        ComplianceSummary:
          type: object
          description: Summary of compliance status
          properties:
            ComplianceStatus:
              type: string
              description: Overall compliance status
            NumberOfCritical:
              type: integer
              description: Number of critical non-compliant components
            NumberOfWarning:
              type: integer
              description: Number of warning non-compliant components
            NumberOfNormal:
              type: integer
              description: Number of compliant components
    FirmwareCatalog:
      type: object
      description: A firmware catalog for compliance and updates
      properties:
        Id:
          type: integer
          description: Unique catalog identifier
        Filename:
          type: string
          description: Catalog filename
        SourcePath:
          type: string
          description: Source location of the catalog
        Repository:
          type: object
          description: Repository details
          properties:
            Name:
              type: string
              description: Repository name
            RepositoryType:
              type: string
              description: Repository type
        Status:
          type: string
          description: Catalog status
        TaskId:
          type: integer
          description: Associated task identifier
  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