Dell Servers Devices API

openapi: 3.2.0
info:
  title: Dell Servers Dell OpenManage Enterprise Devices 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: Devices
  description: Device inventory, status, and hardware details for managed servers
paths:
  /DeviceService/Devices:
    get:
      operationId: listDevices
      summary: Dell Servers List managed devices
      description: Retrieves the collection of devices managed by OpenManage Enterprise including servers, chassis, storage, and network devices. Supports OData query parameters for filtering, sorting, and pagination.
      tags:
      - Devices
      parameters:
      - name: $top
        in: query
        description: Maximum number of devices to return
        schema:
          type: integer
          default: 25
      - name: $skip
        in: query
        description: Number of devices to skip for pagination
        schema:
          type: integer
          default: 0
      - name: $filter
        in: query
        description: OData filter expression to narrow results. Common filters include Type eq 1000 for servers, Type eq 2000 for chassis.
        schema:
          type: string
      - name: $orderby
        in: query
        description: Property name to sort results by
        schema:
          type: string
      responses:
        '200':
          description: Collection of managed devices
          content:
            application/json:
              schema:
                type: object
                properties:
                  '@odata.count':
                    type: integer
                    description: Total number of matching devices
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device'
        '401':
          description: Unauthorized - invalid or expired session token
  /DeviceService/Devices({DeviceId}):
    get:
      operationId: getDevice
      summary: Dell Servers Get a managed device
      description: Retrieves detailed information about a specific managed device including hardware inventory, connection status, health, firmware versions, and assigned groups.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      responses:
        '200':
          description: Device details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
        '401':
          description: Unauthorized - invalid or expired session token
        '404':
          description: Device not found
  /DeviceService/Devices({DeviceId})/InventoryDetails:
    get:
      operationId: getDeviceInventory
      summary: Dell Servers Get device inventory details
      description: Retrieves the detailed hardware inventory for a specific device including processor, memory, storage, network adapter, firmware, and software inventory components.
      tags:
      - Devices
      parameters:
      - $ref: '#/components/parameters/DeviceId'
      responses:
        '200':
          description: Device inventory details
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryDetail'
        '401':
          description: Unauthorized - invalid or expired session token
        '404':
          description: Device not found
components:
  parameters:
    DeviceId:
      name: DeviceId
      in: path
      required: true
      description: Unique identifier for a managed device
      schema:
        type: integer
  schemas:
    Device:
      type: object
      description: A managed device in OpenManage Enterprise
      properties:
        Id:
          type: integer
          description: Unique device identifier
        Type:
          type: integer
          description: Device type code. Common values are 1000 for servers, 2000 for chassis, 3000 for storage, and 4000 for network devices.
        Identifier:
          type: string
          description: Device service tag or serial number
        DeviceServiceTag:
          type: string
          description: Dell service tag for the device
        ChassisServiceTag:
          type: string
          description: Service tag of the chassis containing this device
        Model:
          type: string
          description: Device model name
        DeviceName:
          type: string
          description: User-assigned or auto-discovered device name
        IpAddress:
          type: string
          description: Management IP address of the device
        ManagedState:
          type: integer
          description: Device management state. 3000 indicates managed, 5000 indicates monitored.
        Status:
          type: integer
          description: Device health status code. 1000 is normal, 2000 is unknown, 3000 is warning, 4000 is critical, 5000 is informational.
        ConnectionState:
          type: boolean
          description: Whether the device is currently reachable
        PowerState:
          type: integer
          description: Power state code. 17 is powered on, 18 is powered off, 20 is power cycling.
        FirmwareVersion:
          type: string
          description: Primary firmware version
        LastInventoryTime:
          type: string
          format: date-time
          description: Timestamp of the last inventory collection
        LastStatusTime:
          type: string
          format: date-time
          description: Timestamp of the last status check
    InventoryDetail:
      type: object
      description: Hardware inventory component details
      properties:
        InventoryType:
          type: string
          description: Type of inventory component such as cpuInformation, memoryInformation, storageInformation, nicInformation, or firmwareInformation
        InventoryInfo:
          type: array
          description: Array of inventory items for this component type
          items:
            type: object
            additionalProperties: true
  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