API Guide

Table 1. Redsh authentication and authorization
Redsh actions Authentication required Authorization required
Read operation on any instrumentation data Yes Yes
Modify instrumentation data Yes Yes
Invoke actions Yes Yes
View service root No No
View metadata document No No
View OData service document No No
View message registry No No
View Redsh version URI No No
View JSONSchemaFile resource URI No No
View JSON schemas URI No No
The Redsh service provides access to Redsh URLs by using the following methods:
• Basic authentication: In this method, user name and password are provided for each Redsh API request.
• Session-based authentication: This method is used while issuing multiple Redsh operation requests.
• Session login is initiated by accessing the Create session URI. The response for this request includes an X-Auth-Token header with a
session token. Authentication for subsequent requests is made using the X-Auth-Token header.
• Session logout is performed by issuing a DELETE of the Session resource provided by the Login operation including the X-Auth-
Token header.
NOTE
: The iDRAC rmware incorporates the concept of application sessions for various existing interfaces such as the web
interface, WSMan, and RACADM. With the introduction of Redsh-specic sessions, Redsh inherits the characteristics of web
server sessions and the property Session Timeout inherits the web server session timeout value.
NOTE: To ensure a secure connection, Dell recommends using TLS 1.1 or later.
iDRAC licensing
Redsh support is included in all license types of iDRAC. However, some of the iDRAC features require specic licenses. If a required license
is not present, certain Redsh APIs may not be accessible and return an HTTP 403 status code. 403 implies that there is no sucient
privileges. In other cases, some of the properties in certain resource may not be returned in a response. The service may also return errors
when such properties are modied. For information of specic license requirements for the resources, see Redsh resources.
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 by accessing URIs that can be accessed by using the following HTTP methods:
• GET
• HEAD
• POST
• PUT
• PATCH
• DELETE
Redsh-based
systems management 9