Dell Servers Firmware API

openapi: 3.2.0
info:
  title: Dell Servers Dell OpenManage Enterprise Firmware API
  description: RESTful API for centralized management of Dell EMC servers, chassis, and storage through the OpenManage Enterprise console. Provides discovery, inventory, monitoring, alerting, firmware updates, configuration compliance, and lifecycle management of Dell PowerEdge infrastructure at scale. The API delivers JSON responses over HTTPS and follows OData v4 conventions.
  version: '4.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://{ome-server}/api
  description: OpenManage Enterprise API Server
  variables:
    ome-server:
      description: Hostname or IP address of the OpenManage Enterprise appliance
      default: ome-server.example.com
security:
- sessionAuth: []
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:
    sessionAuth:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: Session token obtained from the POST /SessionService/Sessions endpoint. Must be included in the X-Auth-Token header of all authenticated requests.
externalDocs:
  description: OpenManage Enterprise RESTful API Guide
  url: https://www.dell.com/support/manuals/en-us/dell-openmanage-enterprise/ome_p_api_guide/overview?guid=guid-fc1c0585-795c-41fe-9957-977678be554f&lang=en-us