Skip to main content

GET – Secure boot properties

Use the GET method to retrieve properties in SecureBoot resource for Redfish service.

Request URL

GET https://<BMC_IPADDR>/redfish/v1/Systems/1/SecureBoot

Request body

None

Status code

HTTP Status CodeError Message ID
500InternalError

Response body

The response is a JSON object that contains the following parameters:

FieldTypeDescription

Id

String

“SecureBoot”.

Name

String

“Secure Boot”.

Description

String

UEFI Secure Boot Configuration

SecureBootEnable

Boolean, Null

Enable or disable UEFI Secure Boot (takes effect on next boot).

SecureBootCurrentBoot

String, Null

Secure Boot state during the current boot cycle.

SecureBootMode

String, Null

Current Secure Boot Mode

Property value:
  • “UserMode”

  • “SetupMode”

  • “AuditMode”

  • “DeployedMode”

Actions

Object

Expanded.

 

#SecureBoot.ResetKeys

Object

Refer to the Post section.

  

@Redfish.ActionInfo

Link

/redfish/v1/Systems/1/SecureBoot/ResetKeysActionInfo.

Response example

When the request is successful, a message body similar to the following is returned:

{
"SecureBootCurrentBoot": "Disabled",
"@odata.id": "/redfish/v1/Systems/1/SecureBoot",
"Name": "Secure Boot",
"@odata.context": "/redfish/v1/$metadata#SecureBoot.SecureBoot",
"Id": "SecureBoot",
"@odata.type": "#SecureBoot.v1_0_4.SecureBoot",
"SecureBootEnable": true,
"SecureBootMode": "SetupMode",
"@odata.etag": "\"95230d5e00821715e4de6085f28c564e\"",
"Actions": {
"#SecureBoot.ResetKeys": {
"target": "/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys",
"title": "ResetKeys",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/SecureBoot/ResetKeysActionInfo"
}
},
"Description": "UEFI Secure Boot Configuration"
}