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

Retrieve and restore unrestored keys

Contributors
PDFs

POST /security/key-managers/{security_key_manager.uuid}/restore

Introduced In: 9.13

Retrieves and restores any current unrestored keys (associated with the storage controller) from the specified key management server.

Required properties

  • security_key_manager.uuid - UUID of the key management server. The UUID of the external key manager can be retrieved using [GET /api/security/key-managers].

  • security key-manager external restore

Parameters

Name Type In Required Description

security_key_manager.uuid

string

path

True

Key manager UUID.

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:

Request Body

Name Type Description

_links

_links

key_id

string

Key identifier.

key_server

string

External key server for key management.

key_tag

string

Additional information associated with the key.

node

node
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "key_id": "000000000000000002000000000001003aa8ce6a4fea3e466620134bea9510a10000000000000000",
  "key_server": "keyserver1.com:5698",
  "key_tag": "Authentication-Key-01",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  }
}

Response

Status: 202, Accepted
Name Type Description

job

job_link
Example response 
{
  "job": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "uuid": "string"
  }
}

Response

Status: 201, Created

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65536083

Internal error. Failed to restore the authentication key.

65536843

The key management server is not configured for the SVM.

65536855

Internal error. Failed to restore the volume encryption key.

65538500

This command only restores keys from primary key servers.

Also see the table of common errors in the Response body overview section of this documentation.

Name Type Description

error

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

security_key_manager_restore_keys

Name Type Description

_links

_links

key_id

string

Key identifier.

key_server

string

External key server for key management.

key_tag

string

Additional information associated with the key.

node

node
Name Type Description

_links

_links

uuid

string

The UUID of the asynchronous job that is triggered by a POST, PATCH, or DELETE operation.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_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.