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

List key servers configured in an external key manager

PDFs

GET /security/key-managers/{uuid}/key-servers

Introduced In: 9.6

Retrieves the list of key servers configured in an external key manager.

  • security key-manager external show

  • security key-manager external show-status

Parameters

Name Type In Required Description

uuid

string

path

True

External key manager UUID

username

string

query

False

Filter by username

timeout

integer

query

False

Filter by timeout

secondary_key_servers

string

query

False

Filter by secondary_key_servers

  • Introduced in: 9.8

server

string

query

False

Filter by server

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 15

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[key_server]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "password": "password",
      "secondary_key_servers": [
        "string"
      ],
      "server": "keyserver1.com:5698",
      "timeout": 60,
      "username": "username"
    }
  ]
}

Error

Status: Default, Error
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

next

href

self

href

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

secondary_key_servers

array[string]

A list of the secondary key servers associated with the primary key server.

server

string

External key server for key management. If no port is provided, a default port of 5696 is used. Not valid in POST if records is provided.

timeout

integer

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

username

string

KMIP username credentials for connecting with the key server.

key_server

Name Type Description

_links

_links

password

string

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

secondary_key_servers

array[string]

A list of the secondary key servers associated with the primary key server.

server

string

External key server for key management. If no port is provided, a default port of 5696 is used. Not valid in POST if records is provided.

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.