Skip to main content

GET – Collection for Key

Use the GET method to retrieve properties in key collection for Redfish service.

Request URL​

GET https://<BMC_IPADDR>/redfish/v1/AccountService/Accounts/{1…14}/Keys

Request body​

None

Response body​

FieldTypeDescription

Description

String

A collection of SSH Key resource instances

Name

String

Keys

Members

Array

Items: links

Item count: 1~4

 

Members[N]

Link

Reference Key schema for instance number.

Status code​

HTTP Status CodeError Message ID
500InternalError

Example​

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

{
    "@odata.context": "/redfish/v1/$metadata#KeyCollection.KeyCollection",
    "@odata.etag": "\"1C1EA1FE\"",
    "@odata.id": "/redfish/v1/AccountService/Accounts/1/Keys",
    "@odata.type": "#KeyCollection.KeyCollection",
    "Description": "A collection of SSH Key resource instances.",
    "Members": [],
    "Members@odata.count": 0,
    "Name": "Keys"
}