GET – Service root properties

Use the GET method to retrieve properties in Service Root (/redfish/v1/) for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/

Request body

None

Response body

Field			Type	Description
AccountService			Link	A reference link to account service resource.
CertificateService			Link	A reference link to certificate service resource.
Chassis			Link	A reference link to chassis resource.
Description			String	This resource is used to represent a service root for a Redfish implementation.
EventService			Link	A reference link to event service resource.
Id			String	RootService
JobService			Link	A reference link to job service resource.
JsonSchemeas			Link	A reference link to Json Schema resource.
Links			Object	Expanded.
	Sessions		Link	A reference link to a collection of sessions.
Managers			Link	A reference link to a collection of managers.
Name			String	Root Service
ProtocolFeaturesSupported			Object	Expanded.
	DeepOperations		Object	Expanded.
		DeepPATCH	Boolean	An indication of whether the service supports the deep PATCH operation.
		DeepPOST	Boolean	An indication of whether the service supports the deep POST operation.
	ExcerptQuery		Boolean	Indicates whether the “excerpt” query parameter is supported.
	FilterQuery		Boolean	Indicates whether the $filter query parameter is supported.
	OnlyMemberQuery		Boolean	Indicates whether the “only” query parameter is supported.
	SelectQuery		Boolean	Indicates whether the $select query parameter is supported.
	ExpandQuery		Object	Expanded.
		ExpandAll	Boolean	Indicates whether the $expand support of asterisk (expand all entries) is supported.
		Levels	Boolean	Indicates whether the expand support of the $levels qualifier is supported by the service.
		Links	Boolean	Indicates whether the $expand support of tilde (expand only entries in the Links section) is supported.
		MaxLevels	Integer	Indicates the maximum number value of the $levels qualifier in $expand operations.
		NoLinks	Boolean	Indicates whether the $expand support of period (only expand entries not in the Links section) is supported.
RedfishVersion			String	Version of the implemented Redfish service.
Registries			Link	A reference link to a collection of registries.
SessionService			Link	A reference link to session service resource.
Systems			Link	A reference link to a collection of systems.
Tasks			Link	A reference link to a collection of tasks.
TelemetryService			Link	A reference link to telemetry service resource.
UUID			String	Unique identifier for the service instance.
UpdateService			Link	A reference link to update service resource.
LicenseService			Link	A reference link to license service resource.
Vendor			String	Lenovo

Status code

HTTP Status Code	Error Message ID
500	InternalError

Example

The following example JSON response is returned:

{
    "@odata.etag": "\"119D810A\"",
    "@odata.id": "/redfish/v1",
    "@odata.type": "#ServiceRoot.v1_15_0.ServiceRoot",
    "AccountService": {
        "@odata.id": "/redfish/v1/AccountService"
    },
    "AggregationService": {
        "@odata.id": "/redfish/v1/AggregationService"
    },
    "CertificateService": {
        "@odata.id": "/redfish/v1/CertificateService"
    },
    "Chassis": {
        "@odata.id": "/redfish/v1/Chassis"
    },
    "Description": "This resource is used to represent a service                     root for a Redfish implementation.",
    "EventService": {
        "@odata.id": "/redfish/v1/EventService"
    },
    "Id": "RootService",
    "JobService": {
        "@odata.id": "/redfish/v1/JobService"
    },
    "JsonSchemas": {
        "@odata.id": "/redfish/v1/JsonSchemas"
    },
    "LicenseService": {
        "@odata.id": "/redfish/v1/LicenseService"
    },
    "Links": {
        "Sessions": {
            "@odata.id": "/redfish/v1/SessionService/Sessions"
        }
    },
    "Managers": {
        "@odata.id": "/redfish/v1/Managers"
    },
    "Name": "Root Service",
    "ProtocolFeaturesSupported": {
        "DeepOperations": {
            "DeepPATCH": false,
            "DeepPOST": false
        },
        "ExcerptQuery": false,
        "ExpandQuery": {
            "ExpandAll": true,
            "Levels": true,
            "Links": true,
            "MaxLevels": 2,
            "NoLinks": true
        },
        "FilterQuery": true,
        "OnlyMemberQuery": true,
        "SelectQuery": true
    },
    "RedfishVersion": "1.17.0",
    "Registries": {
        "@odata.id": "/redfish/v1/Registries"
    },
    "SessionService": {
        "@odata.id": "/redfish/v1/SessionService"
    },
    "Systems": {
        "@odata.id": "/redfish/v1/Systems"
    },
    "Tasks": {
        "@odata.id": "/redfish/v1/TaskService"
    },
    "TelemetryService": {
        "@odata.id": "/redfish/v1/TelemetryService"
    },
    "UUID": "FE57AA52-E969-4448-9C0B-045179900052",
    "UpdateService": {
        "@odata.id": "/redfish/v1/UpdateService"
    },
    "Vendor": "Lenovo"
}

Give documentation feedback

GET – Service root properties

Request URL​

Request body​

Response body​

Status code​

Example​

Request URL

Request body

Response body

Status code

Example