API Guide

HTTP headers
The server response contains only basic information about related resources. Any metadata that is required to process a request or
response is accessed by using HTTP headers. iDRAC supports the following request headers:
Header Description
If-Match Supported only for AccountService URI.
If-None-Match Supported only for AccountService and metadata URIs.
Content-Length Returned on all responses except responses that have Transfer-Encoding: chunked.
Content-Type
• Responses other than OData metadata—application/json;charset=utf-8
• OData responses—application/xml;charset=utf-8
ETag Supported on AccountService and metadata URIs.
Location Service sets this header when resources are created or when HTTP requests are redirected to other resources.
Cache-Control Returned on all responses. Metadata URIs support cached responses. Instrumentation resources cannot be
cached.
X-Auth-Token Used for authentication of user sessions. See “Session-based authentication” under Redsh authentication and
authorization.
HTTP status codes and error messages
HTTP denes the status codes that are returned in response messages. When the HTTP status code indicates a failure, the response body
contains an extended error resource, which provides meaningful and deterministic error semantics.
The extended-error information for the Redsh service that Dell has implemented contains error or exception information that is unique to
Dell. This information provides more details and recommendations for error resolution. To learn more about extended-error information, see
the Event and Error Message Reference Guide available at www.dell.com/manuals.
For more information about supported status codes and error messages, see the Redsh Scalable Platforms Management API
Specication document available at www.dmtf.org/standards/redsh.
SSL certicates of iDRAC
iDRAC includes a web server that uses the industry-standard SSL security protocol to transfer encrypted data over a network. Built upon
asymmetric encryption technology, SSL is widely accepted for providing authenticated and encrypted communication between clients and
servers to prevent eavesdropping across a network.
By default, the iDRAC web server has a Dell self-signed SSL digital certicate. Redsh service reuses this certicate installed on the iDRAC
web server. You can replace the default SSL certicate with a certicate signed by a well-known Certicate Authority (CA). You can
replace SSL certicates using the iDRAC interfaces such as web interface, RACADM, or WSMan. For more information on managing SSL
certicates of iDRAC, see the latest iDRAC User’s Guide available at Dell.com/idracmanuals.
Eventing
The Redsh service generates asynchronous notications (events) that are dened by Redsh subscription for the eventing service. These
events are sent to an event destination by using HTTP POST method. Events are generated when some signicant change or error
condition typically of time critical nature occurs. When an event occurs on the service, it noties the clients. Redsh service must be
enabled and iDRAC must be congured to create event subscriptions and to gain read-only privilege for viewing event subscriptions.
Redsh-based
systems management 11