Dell Servers Discovery API

openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Discovery 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: Discovery
  description: Network discovery configuration and job management
paths:
  /DiscoveryConfigService/DiscoveryConfigGroups:
    get:
      operationId: listDiscoveryConfigs
      summary: Dell Servers List discovery configurations
      description: Retrieves the collection of discovery configuration groups that define target ranges, protocols, and credentials used for device discovery.
      tags:
      - Discovery
      responses:
        '200':
          description: Collection of discovery configurations
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscoveryConfigGroup'
        '401':
          description: Unauthorized - invalid or expired session token
    post:
      operationId: createDiscoveryConfig
      summary: Dell Servers Create a discovery configuration
      description: Creates a new discovery configuration group that defines network ranges, protocols, and credentials for discovering devices. When executed, the discovery job scans the specified ranges and adds discovered devices to the managed inventory.
      tags:
      - Discovery
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiscoveryConfigGroup'
      responses:
        '201':
          description: Discovery configuration created
        '400':
          description: Invalid discovery configuration parameters
        '401':
          description: Unauthorized - invalid or expired session token
  /DiscoveryConfigService/Jobs:
    get:
      operationId: listDiscoveryJobs
      summary: Dell Servers List discovery jobs
      description: Retrieves the collection of discovery job instances showing status, progress, and results for discovery operations.
      tags:
      - Discovery
      responses:
        '200':
          description: Collection of discovery jobs
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job'
        '401':
          description: Unauthorized - invalid or expired session token
components:
  schemas:
    DiscoveryConfigGroup:
      type: object
      description: Discovery configuration group defining targets and credentials
      properties:
        DiscoveryConfigGroupId:
          type: integer
          description: Unique discovery configuration identifier
        DiscoveryConfigGroupName:
          type: string
          description: Name of the discovery configuration
        DiscoveryConfigModels:
          type: array
          description: Array of discovery targets with protocol settings
          items:
            type: object
            properties:
              DiscoveryConfigTargets:
                type: array
                description: Target IP ranges or hostnames
                items:
                  type: object
                  properties:
                    NetworkAddressDetail:
                      type: string
                      description: IP address, range, or CIDR notation
              ConnectionProfileId:
                type: integer
                description: Connection profile with credentials
              DeviceType:
                type: array
                description: Device types to discover
                items:
                  type: integer
        Schedule:
          type: object
          description: Discovery schedule configuration
          properties:
            RunNow:
              type: boolean
              description: Execute discovery immediately
            Cron:
              type: string
              description: Cron expression for recurring discovery
    Job:
      type: object
      description: An asynchronous job in OpenManage Enterprise
      properties:
        Id:
          type: integer
          description: Unique job identifier
        JobName:
          type: string
          description: Job name
        JobDescription:
          type: string
          description: Job description
        JobType:
          type: object
          description: Job type information
          properties:
            Id:
              type: integer
              description: Job type identifier
            Name:
              type: string
              description: Job type name
        LastRunStatus:
          type: object
          description: Status of the last job execution
          properties:
            Id:
              type: integer
              description: Status code
            Name:
              type: string
              description: Status description
        JobStatus:
          type: object
          description: Current job status
          properties:
            Id:
              type: integer
              description: Status code
            Name:
              type: string
              description: Status description
        PercentComplete:
          type: integer
          description: Job completion percentage
          minimum: 0
          maximum: 100
        StartTime:
          type: string
          format: date-time
          description: Job start timestamp
        EndTime:
          type: string
          format: date-time
          description: Job completion timestamp
  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