API Guide

Table Of Contents
HTTP status code Extended information
403 Base.1.0. InsufficientPrivilege
404 Base.1.0.ResourceMissingAtURI
500 Base.1.0.InternalError
Examples
NOTE: For more information about Redfish and detailed examples, see the white papers available at https://
www.dmtf.org/standards/redfish.
The following table provides usage examples for the HTTP supported methods such as GET, POST, PATCH, and DELETE:
GET
Table 4. GET usage examples
URL
/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces
Output
{
"@odata.context": "/redfish/v1/$metadata#Managers/Members/iDRAC.Embedded.1/
SerialInterfaces/$entity",
"@odata.count": 1,
"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces",
"@odata.type": "#SerialInterface.1.0.0.SerialInterfaceCollection",
"Description": "Collection of Serial Interfaces for this System",
"Members": [
{
"@odata.id": "/redfish/v1/Managers/iDRAC.Embedded.1/SerialInterfaces/
iDRAC.Embedded.1#Serial.1"
}
],
"Name": "Serial Interface Collection"
}
DELETE
Table 5. DELETE usage examples
URL
/redfish/v1/EventService/Subscriptions/<SubscriptionId>
Output
200 Ok
{
"INFO": "<SubscriptionId> subscription deleted successfully"
}
PATCH
Table 6. PATCH usage examples
URL
/redfish/v1/Managers/iDRAC.Embedded.1/Accounts/<Account-id>
Input
{"Password": "123","UserName": "reader"}
51