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

Update a primary key server

PDFs

PATCH /security/key-managers/{uuid}/key-servers/{server}

Updates a key server.

  • security key-manager external modify-server

Parameters

Name Type In Required Description

uuid

string

path

True

External key manager UUID

server

string

path

True

Key server configured in the external key manager

Request Body

Name Type Description

_links

_links

password

string

Password credentials for connecting with the key server. This is not audited.

timeout

integer

I/O timeout in seconds for communicating with the key server.

username

string

KMIP username credentials for connecting with the key server.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "password": "password",
  "timeout": 60,
  "username": "username"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65536822

Multitenant key management is not supported in the current cluster version.

65536828

External key management is not enabled for the SVM.

65536824

Multitenant key management is not supported in MetroCluster configurations.

65536843

Key management server is not configured for the SVM.

65536846

Missing password.

65536845

Missing username.
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

href

Name Type Description

href

string

_links

Name Type Description

self

href

records

Name Type Description

_links

_links

password

string

Password credentials for connecting with the key server. This is not audited.

timeout

integer

I/O timeout in seconds for communicating with the key server.

username

string

key_server

Name Type Description

_links

_links

password

string

Password credentials for connecting with the key server. This is not audited.

timeout

integer

I/O timeout in seconds for communicating with the key server.

username

string

KMIP username credentials for connecting with the key server.

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.