URI Rules

Redfish Service supports a small set of defined default URIs without authentication.

Table 1. URIs Without Authentication
URI	Description
/redfish	URI used to return the version
/redfish/v1/	URI for the Redfish Service Root
/redfish/v1/odata	URI for OData Service Document
/redfish/v1/$metadata	URI for metadata document
/redfish/v1/openapi.yaml	URI for OpenAPI document

The following Redfish URI is redirected to the Associated URI as given below:

Table 2. Associated URI
URI	Associated Redfish-Defined URI
/redfish/v1	/redfish/v1/

Note

The other defined and relative Redfish URIs are accessed using basic Authentication.
All URI with a trailing slash will be redirected to the same URI without a trailing slash and will send the response status and body as the original URI
For example: "/redfish/v1/Systems/{{system_instance}}/" with a trailing slash will be redirected to "/redfish/v1/Systems/{{system_instance}}" and both will display the same response.

URI Character Syntax

A URI should include a limited set of US-ASCII-defined characters and not include any RFC1738-defined unsafe characters.

Table 3. URI Characters
Type	Characters	Note
Allowed	digits ("0" to "9")
	letters ("A" to "Z"/ "a" to "z")
	hyphen ("-")
	period(".")
	underscore("_")
Not allowed	greater-than symbol and less-than symbol(">" and "<")	Unsafe because they are used as the delimiters around URLs in free text.
	quotation mark(" ")	Unsafe because it is used to delimit URLs in some systems.
	hash sign("#")	Unsafe and should always be encoded because it is used on World Wide Web and in other systems to delimit a URL from a fragment/anchor identifier that might follow it. Note Do not use the character for anything other than the start of a fragment.
	percent sign("%")	Unsafe because it is used for encodings of other characters.
	curly braces("{" and "}") vertical bar("\|") backslash("\") caret("^") tilde("~") tilde("[" and "]") grave accent("`") space(" ")	Unsafe because gateways and other transport agents are known to sometimes modify such characters.

Give documentation feedback