Dell Servers Groups API

openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Groups 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: 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:
    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