Skip to main content

Retrieve key manager configurations

Contributors
PDFs

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

Introduced In: 9.11

Retrieves key manager configurations.

Required properties

  • security_key_manager.uuid - Key manager UUID.

  • node.uuid - Node UUID.

  • security key-manager key query

  • security key-manager key query -node <node>

  • security key-manager key query -node <node> -key-manager <key_manager>

Parameters

Name Type In Required Description

key_user

string

query

False

Filter by key_user

  • Introduced in: 9.12

key_tag

string

query

False

Filter by key_tag

  • Introduced in: 9.12

key_manager

string

query

False

Filter by key_manager

  • Introduced in: 9.12

encryption_algorithm

string

query

False

Filter by encryption_algorithm

  • Introduced in: 9.12

crn

string

query

False

Filter by crn

  • Introduced in: 9.12

node.name

string

query

False

Filter by node.name

  • Introduced in: 9.12

policy

string

query

False

Filter by policy

  • Introduced in: 9.12

restored

boolean

query

False

Filter by restored

  • Introduced in: 9.12

key_store_type

string

query

False

Filter by key_store_type

  • Introduced in: 9.12

svm.uuid

string

query

False

Filter by svm.uuid

  • Introduced in: 9.14

svm.name

string

query

False

Filter by svm.name

  • Introduced in: 9.14

key_type

string

query

False

Filter by key_type

  • Introduced in: 9.12

key_store

string

query

False

Filter by key_store

  • Introduced in: 9.12

scope

string

query

False

Filter by scope

  • Introduced in: 9.14

key_id

string

query

False

Filter by key_id

  • Introduced in: 9.12

key_server

string

query

False

Filter by key_server

  • Introduced in: 9.12

security_key_manager.uuid

string

path

True

Key manager UUID.

node.uuid

string

path

True

Node UUID.

max_records

integer

query

False

Limit the number of records returned.

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

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: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of records

records

array[key_manager_keys]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "_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": "onboard",
    "key_store_type": "okm",
    "key_tag": "key#",
    "key_type": "nse_ak",
    "key_user": "vs1",
    "node": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "node1",
      "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
    },
    "policy": "IBM_Key_Lore",
    "restored": 1,
    "scope": "svm",
    "svm": {
      "_links": {
        "self": {
          "href": "/api/resourcelink"
        }
      },
      "name": "svm1",
      "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
    }
  }
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65537125

The provided key manager UUID is not the UUID of a keymanager.

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

next

href

self

href
Name Type Description

self

href

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

key_manager_keys

Displays the keys stored in a key manager.

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.

scope

string

Set to "svm" for interfaces owned by an SVM. Otherwise, set to "cluster".

svm

svm

SVM, applies only to SVM-scoped objects.

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.