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 details about the error messages, see the following:

• Base messages: Registries > BaseMessage schema. Examples of base messages are GeneralError, PropertyUnknown,

InsucientPrivilege, and so on.

• Event and Error messages: Registries > Message schema. Examples of Event and Error messages are AMP0300, ASR0001, HWC7014,

and so on.

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.

NOTE

• For some URLs, if you execute an unsupported method, the response code may not indicate that the method is unsupported. To

see the methods that the URL supports, see the relevant section in this document. You can also use the Get method on the URL

and see the supported methods in the response.

• If you perform a Patch operation on multiple attributes, and if some attributes do not get updated due to dependency issues, HTTP

code 400 is returned.

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.

Redsh-based systems management