Endpoint

/v2/encryption/external-kms/keys/create

POST

Create a Key in the Key Management Server.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "encryption_api_v2_create_kmip_key",
  "type": "object",
  "properties": {
    "kms_config": {
      "description": "The Key Management Server server parameters. If this is omitted and a Key Management Server is already configured, the parameters from the existing configuration will be used. It is an error to omit this field if Key Management Server is not already configured on the cluster.",
      "type": "object",
      "properties": {
        "server_ca_cert": {
          "description": "The Certificate Authority certificate that Qumulo Core uses to validate the certificate that the Key Management Server presents to client TLS connections.",
          "type": "string"
        },
        "client_cert": {
          "description": "The client certificate that Qumulo Core uses to authenticate the cluster to the Key Management Server.",
          "type": "string"
        },
        "client_private_key": {
          "description": "The private key that corresponds to the specified client certificate.",
          "type": "string"
        },
        "hostname": {
          "description": "The hostname of the Key Management Server.",
          "type": "string"
        },
        "port": {
          "description": "The port number of the Key Management Server, 5696 by default.",
          "type": "number"
        }
      }
    },
    "key_name": {
      "description": "The name of the key that will be created in the Key Management Server.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "encryption_api_v2_create_kmip_key_result",
  "type": "object",
  "properties": {
    "key_id": {
      "description": "The key id of the newly created key on the Key Management Server.",
      "type": "string"
    }
  }
}