Dell Servers Groups API

openapi: 3.2.0
info:
  title: Dell Servers Dell OpenManage Enterprise Groups 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: Groups
  description: Device group management for organizing servers and infrastructure
paths:
  /GroupService/Groups:
    get:
      operationId: listGroups
      summary: Dell Servers List device groups
      description: Retrieves the collection of device groups configured in OpenManage Enterprise, including built-in system groups and user-created custom groups. Groups are used to organize devices for monitoring, reporting, and applying policies.
      tags:
      - Groups
      parameters:
      - name: $filter
        in: query
        description: OData filter expression to narrow results
        schema:
          type: string
      responses:
        '200':
          description: Collection of device groups
          content:
            application/json:
              schema:
                type: object
                properties:
                  '@odata.count':
                    type: integer
                    description: Total number of groups
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
        '401':
          description: Unauthorized - invalid or expired session token
  /GroupService/Groups({GroupId})/Devices:
    get:
      operationId: listGroupDevices
      summary: Dell Servers List devices in a group
      description: Retrieves the collection of devices that are members of the specified group. Supports OData query parameters for filtering and pagination.
      tags:
      - Groups
      parameters:
      - $ref: '#/components/parameters/GroupId'
      responses:
        '200':
          description: Collection of devices in the group
          content:
            application/json:
              schema:
                type: object
                properties:
                  '@odata.count':
                    type: integer
                    description: Total devices in group
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device'
        '401':
          description: Unauthorized - invalid or expired session token
        '404':
          description: Group not found
components:
  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
    Group:
      type: object
      description: A device group for organizing managed infrastructure
      properties:
        Id:
          type: integer
          description: Unique group identifier
        Name:
          type: string
          description: Group name
        Description:
          type: string
          description: Group description
        MembershipTypeId:
          type: integer
          description: Group membership type. 12 is static, 24 is dynamic query-based.
        ParentId:
          type: integer
          description: Parent group identifier for nested groups
        CreatedBy:
          type: string
          description: User who created the group
        CreationTime:
          type: string
          format: date-time
          description: Timestamp when the group was created
        DefinitionId:
          type: integer
          description: Group definition identifier
        Visible:
          type: boolean
          description: Whether the group is visible in the UI
  parameters:
    GroupId:
      name: GroupId
      in: path
      required: true
      description: Unique identifier for a device group
      schema:
        type: integer
  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