Skip to main content
A newer release of this product is available.

Restore keys for an SVM from a configured AKV

Contributors
PDFs

POST /security/azure-key-vaults/{azure_key_vault.uuid}/restore

Introduced In: 9.8

Restore the keys for an SVM from a configured AKV. Note: This method is only available to the Azure NetApp Files Cloud Volume Services.

  • security key-manager external azure restore

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.

  • Default value: 1

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65537120

Azure Key Vault is not configured for the given SVM.

65537515

Failed to restore keys on some nodes in the cluster.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

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.