Skip to content

6. Redfish Service Root

To get the Redfish service root, perform a GET operation on the Redfish service root URI. Authentication is not needed because this resource is not protected.

curl -k 'https://<REDFISH-HOST>/redfish/v1/' | python -m json.tool

The following example shows a sample Redfish service root:

{
    "@odata.id": "/redfish/v1/",
    "@odata.type": "#ServiceRoot.v1_16_1.ServiceRoot",
    "AccountService": {
        "@odata.id": "/redfish/v1/AccountService"
    },
    "Id": "RootService",
    "Links": {
        "Sessions": {
            "@odata.id": "/redfish/v1/SessionService/Sessions"
        }
    },
    "Managers": {
        "@odata.id": "/redfish/v1/Managers"
    },
    "Name": "Root Service",
    "RedfishVersion": "1.15.0",
    "SessionService": {
        "@odata.id": "/redfish/v1/SessionService"
    },
    "Systems": {
        "@odata.id": "/redfish/v1/Systems"
    },
    "UpdateService": {
        "@odata.id": "/redfish/v1/UpdateService"
    },
    "Chassis": {
        "@odata.id": "/redfish/v1/Chassis"
    },
    "UUID": "92384634-2938-2342-8820-489239905423"
}

The service root includes hyperlinks to the top-level resource collections and services supported by the implementation. For example, the AccountService property contains a hyperlink to the account service, shown by the value /redfish/v1/AccountService for its @odata.id property.

The following table lists the top-level resource collections and services that are commonly found in Redfish services.

This table is not exhaustive for every possible property in the service root.

Property Description
Systems Collection of systems managed by the service.
AccountService Provides management of user accounts and roles, including creation, deletion, modification, and access control.
Managers Represents the management controllers (such as BMCs) that provide out-of-band management for the system.
SessionService Provides session-based authentication and authorization, including login, logout, and token management.
UpdateService Provides mechanisms to update firmware, including image upload, and installation control.
Chassis Represents the physical enclosure, including power, sensors, and intrusion detection.

Next section