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

Retrieve key management key information for specified keys

PDFs

GET /security/key-managers/{security_key_manager.uuid}/keys/{node.uuid}/key-ids/{key_id}

Introduced In: 9.11

Retrieves the key management keys information for the specified key_id.

  • security key-manager key query -key-id <key_id>

Parameters

Name Type In Required Description

security_key_manager.uuid

string

path

True

Key manager UUID.

node.uuid

string

path

True

Node UUID.

key_id

string

path

True

Key identifier.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
Name Type Description

_links

self_link

crn

string

Cloud resource name.

encryption_algorithm

string

Encryption algorithm for the key

key_id

string

Key identifier.

key_manager

string

Key manager key server managing the key. Indicates the external key server when external key manager is configured.

key_server

string

External key server for key management.

key_store

string

Security key manager configured for the given key manager UUID. Key manager keystore value can be onboard or external.

key_store_type

string

Security key manager keystore type. Keystore type can be onboard, external, or supported cloud key manager.

key_tag

string

Additional information associated with the key.

key_type

string

Encryption Key type.

key_user

string

SVM associated with the key.

node

node

policy

string

Key store policy.

restored

boolean

Indicates whether the key is present locally on the node.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "crn": "CRN=v1:bluemix:public:containers-kubernetes",
  "encryption_algorithm": "XTS-AES-256",
  "key_id": "000000000000000002000000000001008963c9213194c59555c1bec8db3603c800000000",
  "key_manager": "keyserver1.local:5696",
  "key_server": "keyserver1.com:5698",
  "key_store": "string",
  "key_store_type": "string",
  "key_tag": "key#",
  "key_type": "string",
  "key_user": "vs1",
  "node": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "node1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "policy": "IBM_Key_Lore",
  "restored": 1
}

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
Name Type Description

self

href

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

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.