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

Retrieve key servers configured in an external key manager

Contributors
PDFs

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

Introduced In: 9.6

Retrieves 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

server

string

path

True

Key server configured in the key manager.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

_links

password

string

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

records

array[records]

An array of key servers specified to add multiple key servers to a key manager in a single API call. Valid in POST only and not valid if server is provided.

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.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "password": "password",
  "records": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "password": "password",
    "secondary_key_servers": {
    },
    "server": "keyserver1.com:5698",
    "timeout": "60",
    "username": "username"
  },
  "secondary_key_servers": {
  },
  "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

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.

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.