Restore keys for an SVM from a configured AWS KMS
Suggest changes
PDFs
POST /security/aws-kms/{aws_kms.uuid}/restore
Introduced In: 9.12
Restores the keys for an SVM from a configured AWS KMS.
Related ONTAP commands
-
security key-manager external AWS restore
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
aws_kms.uuid |
string |
path |
True |
UUID of the existing AWS KMS configuration. |
return_timeout |
integer |
query |
False |
The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.
|
return_records |
boolean |
query |
False |
The default is false. If set to true, the records are returned.
|
Response
Status: 202, AcceptedHeaders
| Name | Description | Type |
|---|---|---|
Location |
Useful for tracking the resource location |
string |
Error
Status: DefaultONTAP Error Response Codes
| Error Code | Description |
|---|---|
65536082 |
Unable to restore all keys. |
65537544 |
Missing wrapped top-level internal key protection key (KEK) from internal database. |
65537926 |
The Amazon Web Service Key Management Service is not configured for the given SVM. |
Definitions
See Definitions
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |