openapi: 3.1.0
info:
  title: Dell Servers Dell iDRAC Redfish REST Accounts Service Root 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: Service Root
  description: Redfish service root and metadata
paths:
  /:
    get:
      operationId: getServiceRoot
      summary: Dell Servers Get Redfish service root
      description: Retrieves the Redfish service root resource which provides links to all top-level resource collections and service metadata including the Redfish protocol version and available services.
      tags:
      - Service Root
      responses:
        '200':
          description: Service root resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceRoot'
        '401':
          description: Unauthorized - invalid or missing credentials
components:
  schemas:
    ServiceRoot:
      type: object
      description: Redfish service root resource providing links to top-level collections
      properties:
        '@odata.id':
          type: string
          description: OData resource identifier
        '@odata.type':
          type: string
          description: OData resource type
        Id:
          type: string
          description: Resource identifier
        Name:
          type: string
          description: Resource name
        RedfishVersion:
          type: string
          description: Redfish protocol version supported
        Systems:
          $ref: '#/components/schemas/ResourceLink'
        Chassis:
          $ref: '#/components/schemas/ResourceLink'
        Managers:
          $ref: '#/components/schemas/ResourceLink'
        AccountService:
          $ref: '#/components/schemas/ResourceLink'
        SessionService:
          $ref: '#/components/schemas/ResourceLink'
        UpdateService:
          $ref: '#/components/schemas/ResourceLink'
        EventService:
          $ref: '#/components/schemas/ResourceLink'
        TaskService:
          $ref: '#/components/schemas/ResourceLink'
        TelemetryService:
          $ref: '#/components/schemas/ResourceLink'
    ResourceLink:
      type: object
      description: Link to a Redfish resource
      properties:
        '@odata.id':
          type: string
          description: OData resource URI
  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