Dell Redfish API Reference Guide v1.0 - Specifications and User Documentation
Summary
Reference guide for the Dell Redfish API version 1.0, documenting the REST-based systems management interface for Dell servers. Covers supported HTTP methods, request/response headers, status codes, error message formats, and key Redfish technologies for out-of-band management. Provides schema definitions and endpoint descriptions enabling programmatic server hardware monitoring, configuration, and task automation through standardized Redfish protocol interactions.
Page 1 Text Content
Redfish API Reference Guide v1.0
Page Summary Contents For Dell Redfish API Reference Guide v1.0 - Specifications and User Documentation
Page 1
Redfish API Reference Guide v1.0
Page 2
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates either potential damage to hardware or loss of ...
Page 3
Contents Overview........................................................................................................................... Benefits......................................................
Page 4
Serial Interfaces................................................................................................................................................................ Service Root.............
Page 5
Overview The Redfish Scalable Platforms Management API is a standard defined by the Distributed Management Task Force (DMTF). Redfish is a next-generation systems management interface standard, which ...
Page 6
Redfish Based Systems Management This section provides an overview of Redfish service implemented in the i DRAC firmware. It includes information about the Redfish API, schema, configuration, authenti...
Page 7
Redfish Schema This is the Schema definitions for Redfish resources. It is defined according to OData Schema representation that can be directly translated to a JSON Schema representation. Redfish Aut...
Page 8
HTTP Methods The REST API allows you to specify the type of request. It adheres to the Create, Retrieve, Update, and Delete (CRUD) standard format. The data is generated via access to URIs, which can ...
Page 9
HTTP Headers The server response contains only basic information about related resources. Any metadata, which is required to process a request or response is accessed by using HTTP headers. i DRAC sup...
Page 10
change or error condition typically of time critical nature occurs. When an event occurs on the service, it notifies the clients. Redfish service must be enabled and i DRAC must be configured to creat...
Page 11
Power Edge FX2/FX2s Chassis Management using i DRAC Redfish On a Power Edge FX2/FX2s chassis, i DRAC can monitor and manage chassis components such as fans, power supplies, and so on. Redfish service ...
Page 12
Redfish Resources This section describes the resource URIs and related operations that are available in the i DRAC implementation of a Redfish service API. Account Service Description This resource is...
Page 13
Supported Status Codes HTTP Status Code Extended Information Base.1.0.success Base.1.0.Property Value Type Error Base.1.0.Property Value Not In List Base.1.0.Property Unknown Base.1.0.Property Not Wri...
Page 14
HTTP Status Code Extended Information Base.1.0.Property Not Writable Base.1.0.Property Value Format Error Base.1.0.Internal Error /redfish/v1/Chassis/<ID>/Sensors/Voltages/<ID> Description...
Page 15
Supported HTTP Methods and Privileges HTTP Method Required Privilege PATCH Configure Manager Supported Status Codes and Error Messages HTTP Status Code Extended Information Base.1.0.success Base.1.0.P...
Page 16
Supported Action — Reset Description Resets computer system. URL /redfish/v1/Systems/<ID>/Actions/Computer System.Reset Supported HTTP Methods and Privileges HTTP Method Required Privilege POST ...
Page 17
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login URL /redfish/v1/Managers/<Manager Instance ID>/Ethernet Interfaces/<Ethernet Instance ID> Supported HTTP Meth...
Page 18
Supported Status Codes HTTP Status Code Implementation Notes Some of the properties in this schema are dependent on the installed BIOS and i SM version. If a compatible version of BIOS is not installe...
Page 19
Updatable Properties Parameter Value Message Id <Subscription-id> Supported Status Codes HTTP Status Code Extended Information Base.1.0.Property Value Type Error Base.1.0.Property Value Not In L...
Page 20
Supported Status Codes HTTP Status Code Extended Information Base.1.0.Property Value Type Error Base.1.0.Property Value Not In List Base.1.0.Property Unknown Base.1.0.Property Not Writable Base.1.0.Pr...
Page 21
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Reference Properties /redfish/v1/Managers/<ID>/Logs/Lclog Description This ...
Page 22
Log Service Description This resource is used to represent a log service for a Redfish implementation. URL /redfish/v1/Managers/<ID>/Log Service Supported HTTP Methods and Privileges HTTP Method...
Page 23
Supported Status Codes HTTP Status Code Supported Action — Clear Log URL /redfish/v1/Managers/<ID>/Log Services/Sel/Actions/Log Service.Clear Log Description Performs clear operation on logs. Su...
Page 24
Supported Status Codes HTTP Status Code Supported Attributes and Values Attributes Values Manager Type BMC Command Connect Types Supported SSH Telnet IPMI Graphical Connect Types Supported KVMIP Reset...
Page 25
URL /redfish/v1/Managers/<ID>/Accounts Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Navigation URL /redfish/v1/Managers/<ID>/Accounts/<Account-id> S...
Page 26
Updatable Properties Parameter Description FQDN updates FQDN hostname updates hostname HTTP updates HTTP HTTPS updates HTTPS IPMI updates IPMI KVMIP updates KVMIP SNMP updates SNMP SSH updates SSH Tel...
Page 27
Supported Status Codes HTTP Status Code Power Description This resource is used to represent a power metrics resource for a Redfish implementation. URL /redfish/v1/Chassis/<ID>/Power Supported H...
Page 28
Updatable Properties Parameter Description Power Limit updates Power Limit Supported Status Codes HTTP Status Code Extended Information Base.1.0.success Base.1.0.Property Value Type Error Base.1.0.Pro...
Page 29
/redfish/v1/Chassis/<ID>/Power/Redundancy/<ID> Description This object represents the Redundancy element property. Supported HTTP Methods and Privileges HTTP Method Required Privilege GET ...
Page 30
Role Description This resource is used to represent resources that represent the user role for the user account. URL /redfish/v1/Managers/<ID>/Roles Supported HTTP Methods and Privileges HTTP Me...
Page 31
Updatable Properties Parameter Description Bit Rate updates Bit Rate Interface Enabled updates Interface Enabled Supported Status Codes HTTP Status Code Extended Information Base.1.0.success Base.1.0....
Page 32
Supported HTTP Methods and Privileges HTTP Method Required Privilege GET Login Supported Status Codes HTTP Status Code Session URL /redfish/v1/Sessions Description This resource is used to represent a...
Page 33
/redfish/v1/Sessions/<session-id> Description Performs delete operation on session-id. Supported HTTP Methods and Privileges HTTP Method Required Privilege DELETE Login Supported Status Codes HT...
Page 34
Simple Storage Description This property contains the UEFI device path used to identify and locate a specific storage controller. URL /redfish/v1/Systems/<ID>/Storage/Controllers Supported HTTP ...
Page 35
Thermal Description This resource is used to represent the thermal metrics resource for a Redfish implementation. URL /redfish/v1/Chassis/<ID>/Thermal Supported HTTP Methods and Privileges HTTP ...
Page 36
Supported Status Codes and Error Messages HTTP Status Code NOTE: On Power Edge FX2 systems, i DRAC can display additional instrumentation data from the sensors on the server, only if the Chassis Monit...
Page 37
Supported Attributes and Values Attributes Values Media Types CD USBStick Connected Via Not Connected Applet VLan Network Interface Description The value of this property indicates if VLAN is enabled ...
Page 38
Examples The following table provides usage examples for the HTTP supported methods such as GET, POST, PATCH, and DELETE: GET Table 3. GET Usage Examples URL /redfish/v1/Managers/i DRAC.Embedded.1/Ser...
Page 39
POST Table 6. POST Usage Examples URL /redfish/v1/Systems/System.Embedded.1/Actions/Computer System.Reset Input {"Reset Type":"Graceful Restart"} Output 204: No Content
Manual Details
| Brand | Dell |
|---|---|
| Pages | 39 |
| File Size | 941.48 KB |
| Published | June 15, 2026 |
6 views
Enter the captcha to get the download link:
Frequently Asked Questions
What is a CAUTION in the manual?
A CAUTION indicates potential damage to hardware or loss of data and tells you how to avoid the problem.
How can I reset the system using Redfish?
Use a POST request, for example: /redfish/v1/Systems/System.Embedded.1/Actions/ComputerSystem.Reset URL with { "ResetType":"GracefulRestart"}.
Where is information on VLAN support for Ethernet interfaces?
Check the resource at /redfish/v1/Systems/<ID>/EthernetInterfaces/<EthernetInstanceID>/Vlans, which supports GET requests and returns application/json data.