Re-key the external key in the key hierarchy
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
POST /security/azure-key-vaults/{azure_key_vault.uuid}/rekey-external
Introduced In: 9.11
Rekeys the external key in the key hierarchy for an SVM with an AKV configuration.
Required properties
-
key_id
- Key identifier of the new AKV key encryption key.
Related ONTAP commands
-
security key-manager external azure rekey-external
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
azure_key_vault.uuid |
string |
path |
True |
UUID of the existing AKV 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.
|
Request Body
Name | Type | Description |
---|---|---|
key_id |
string |
Key identifier of the AKV key encryption key. |
Example request
{
"key_id": "https://keyvault1.vault.azure.net/keys/key1/12345678901234567890123456789012"
}
Response
Status: 202, Accepted
Name | Type | Description |
---|---|---|
job |
Example response
{
"job": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"uuid": "string"
}
}
Response
Status: 201, Created
Error
Status: Default
ONTAP Error Response Codes
Error Code | Description |
---|---|
65537120 |
Azure Key Vault is not configured for the given SVM. |
65537547 |
One or more volume encryption keys for encrypted volumes of this data SVM are stored in the key manager configured for the admin SVM. Use the REST API POST method to migrate this data SVM's keys from the admin SVM's key manager to this data SVM's key manager before running the rekey operation. |
Also see the table of common errors in the Response body overview section of this documentation.
Name | Type | Description |
---|---|---|
error |
Example error
{
"error": {
"arguments": [
{
"code": "string",
"message": "string"
}
],
"code": "4",
"message": "entry doesn't exist",
"target": "uuid"
}
}
Definitions
See Definitions
azure_key_vault_key
Name | Type | Description |
---|---|---|
key_id |
string |
Key identifier of the AKV key encryption key. |
href
Name | Type | Description |
---|---|---|
href |
string |
_links
Name | Type | Description |
---|---|---|
self |
job_link
Name | Type | Description |
---|---|---|
_links |
||
uuid |
string |
The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation. |
error_arguments
Name | Type | Description |
---|---|---|