Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

iDRAC9 with Lifecycle Controller Version 3.21.21.21 Redfish API Guide

PDF

URL support

Redfish is a web-based API which implies that resources are accessed using client supplied URLs. URLs are required to identify the Redfish resources. The Redfish API uses a simple URL hierarchy which follows a /redfish/v1/ /redfish/v1/ pattern for all resources. To access a Redfish resource, use the URL pattern https://<iDRAC IP>/redfish/v1/<Resource Path>https://<iDRAC IP>/redfish/v1/<Resource Path>. For more information on the supported resources, see Redfish resources. iDRAC supports the following URL patterns:
  • /redfish/redfish — URL for the Redfish version object.
  • /redfish/v1/redfish/v1 — Root URL for version 1 of the Redfish services.
  • /redfish/v1/odata/redfish/v1/odata — Redfish services expose an OData service document at this URI. This service document provides a standard format for enumerating resources that are exposed by the service by enabling all generic hypermedia-driven OData clients to navigate to the resources of the service.
  • /redfish/v1/$metadata/redfish/v1/$metadata — Redfish services expose a metadata document in XML format. This document describes the resources and collections that are available at the service root URI. It also provides references to other metadata documents, which describe the complete set of resource types that are exposed by the service.
  • /redfish/v1/$metadata#<Collection or a Singleton resource>/redfish/v1/$metadata#<Collection or a Singleton resource> — Metadata URL specified as a part of @odata.context property for all resources. This URL returns data in XML format.
  • /redfish/v1/JsonSchemas/redfish/v1/JsonSchemas — This URL returns data in JSON format. The output is a collection of the JsonSchemaFile resource instances.
  • /redfish/v1/JsonSchemas/<resource URI>/redfish/v1/JsonSchemas/<resource URI> — The JSON Schema File resource instance describes the location (URI) of a particular Redfish schema definition being implemented or referenced by a Redfish service. This URL returns data in JSON format.
  • /redfish/v1/<other resource specific URIs>/redfish/v1/<other resource specific URIs> — All instrumentation resources follow this pattern.

NOTE: The Redfish standard implemented in iDRAC supports only HTTPS protocol.

NOTE: In previous versions of Redfish implementation, # character was parsed as #. Because this character is treated as a break character by the code, any characters after # were ignored. Now, # character is automatically converted to %23. This conversion allows the consoles or REST clients to use the URL without any errors.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\