Skip to main content

Security key-managers security_key_manager.uuid keys node.uuid key-ids endpoint overview

Contributors
PDFs

Overview

Retrieves the key manager keys on the give node. The following operations are supported:

  • Get

Examples

Retrieving key manager key-id information for a node

The following example shows how to retrieve key-ids present on a node for a key manager.

# The API:
GET /api/security/key-managers/{security_key_manager.uuid}/keys/{node.uuid}/key-ids

# The call:
curl -X GET 'https://<mgmt-ip>/api/security/key-managers/f4f98a48-8a5c-c548-cd03-c6335f5803a8/keys/00000000-0000-0000-0000-000000000000/key-ids/000000000000000002000000000005009ad4da8fea2cafe2bed803078b780ebe0000000000000c01' -H 'accept: application/hal+json'

# The response:
{
  "security_key_manager": {
    "uuid": "f4f98a48-8a5c-c548-cd03-c6335f5803a8"
  },
  "node": {
    "uuid": "00000000-0000-0000-0000-000000000000"
  },
  "key_id": "000000000000000002000000000005009ad4da8fea2cafe2bed803078b780ebe0000000000000c01",
  "svm": {
    "name": "cluster-1"
  },
  "key_tag": "vsim1",
  "key_type": "vek",
  "restored": false,
  "key_store": "onboard",
  "key_user": "datavs",
  "key_manager": "onboard",
  "key_store_type": "okm",
  "encryption_algorithm": "XTS-AES-256",
  "_links": {
    "self": {
      "href": "/api/security/key-managers/f4f98a48-8a5c-c548-cd03-c6335f5803a8/keys/00000000-0000-0000-0000-000000000000/key-ids/000000000000000002000000000005009ad4da8fea2cafe2bed803078b780ebe0000000000000c01"
    }
  }
}

Retrieving key manager key-id information of a specific key-type for a node

The following example shows how to retrieve key-ids of a specific key-type present on a node for a key manager.

= The API:

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

= The call:

curl -X GET "https://+++<mgmt-ip>+++/api/security/key-managers/7c179931-044b-11ed-b7cd-005056bbc535/keys/44dac31e-0449-11ed-b7cd-005056bbc535/key-ids?key_type=nse_ak&return_records=true&return_timeout=15" -H "accept: application/json"+++</mgmt-ip>+++

= The response:

{
  "records": [
    {
      "key_server": "10.225.89.34:5696",
      "key_id": "000000000000000002000000000001003d5c5f8c497e8e36aa80566e08749a3d0000000000000000",
      "key_type": "nse_ak"
    },
    {
      "key_server": "10.225.89.34:5696",
      "key_id": "00000000000000000200000000000100c2dce9a3a15aeb8480db8d49c17d056c0000000000000000",
      "key_type": "nse_ak"
    }
  ],
  "num_records": 2
}