Generate a KMS key

curl --request POST \
  --url https://{host}/api/v3/kms/create/{proxy} \
  --header 'Content-Type: application/json' \
  --header 'X-Qanapi-Authorization: <api-key>' \
  --data '
{
  "key_length": 256,
  "rsa_modulus": 2048,
  "usage_mask": [],
  "name": "<string>",
  "external_id": "<string>",
  "classification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "classification": "<string>",
  "private_material_retrievable": false,
  "export_window_expires_at": "2023-11-07T05:31:56Z",
  "export_on_create": false,
  "wrap_with_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://{host}/api/v3/kms/create/{proxy}"

payload = {
    "key_length": 256,
    "rsa_modulus": 2048,
    "usage_mask": [],
    "name": "<string>",
    "external_id": "<string>",
    "classification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "classification": "<string>",
    "private_material_retrievable": False,
    "export_window_expires_at": "2023-11-07T05:31:56Z",
    "export_on_create": False,
    "wrap_with_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-Qanapi-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Qanapi-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key_length: 256,
    rsa_modulus: 2048,
    usage_mask: [],
    name: '<string>',
    external_id: '<string>',
    classification_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    classification: '<string>',
    private_material_retrievable: false,
    export_window_expires_at: '2023-11-07T05:31:56Z',
    export_on_create: false,
    wrap_with_key_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://{host}/api/v3/kms/create/{proxy}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/v3/kms/create/{proxy}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key_length' => 256,
    'rsa_modulus' => 2048,
    'usage_mask' => [
        
    ],
    'name' => '<string>',
    'external_id' => '<string>',
    'classification_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'classification' => '<string>',
    'private_material_retrievable' => false,
    'export_window_expires_at' => '2023-11-07T05:31:56Z',
    'export_on_create' => false,
    'wrap_with_key_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Qanapi-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/v3/kms/create/{proxy}"

	payload := strings.NewReader("{\n  \"key_length\": 256,\n  \"rsa_modulus\": 2048,\n  \"usage_mask\": [],\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"classification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"classification\": \"<string>\",\n  \"private_material_retrievable\": false,\n  \"export_window_expires_at\": \"2023-11-07T05:31:56Z\",\n  \"export_on_create\": false,\n  \"wrap_with_key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Qanapi-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/api/v3/kms/create/{proxy}")
  .header("X-Qanapi-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key_length\": 256,\n  \"rsa_modulus\": 2048,\n  \"usage_mask\": [],\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"classification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"classification\": \"<string>\",\n  \"private_material_retrievable\": false,\n  \"export_window_expires_at\": \"2023-11-07T05:31:56Z\",\n  \"export_on_create\": false,\n  \"wrap_with_key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/v3/kms/create/{proxy}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Qanapi-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key_length\": 256,\n  \"rsa_modulus\": 2048,\n  \"usage_mask\": [],\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"classification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"classification\": \"<string>\",\n  \"private_material_retrievable\": false,\n  \"export_window_expires_at\": \"2023-11-07T05:31:56Z\",\n  \"export_on_create\": false,\n  \"wrap_with_key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "external_id": "<string>",
  "type": "AES",
  "algorithm": "AES-256",
  "state": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "private_material_retrievable": true,
  "usage_mask": [
    "encrypt"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "cipher_mode": "gcm",
  "classification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revoke_reason": "<string>",
  "rotated_from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "export_window_expires_at": "2023-11-07T05:31:56Z",
  "export_count": 123,
  "public_key_pem": "<string>",
  "private_key_material": {
    "jwe": "<string>"
  }
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException",
  "errors": {
    "type": [
      "The type field is required."
    ],
    "configuration_ids": [
      "No configuration has the id `...`."
    ]
  }
}

KMS

Generate a KMS key

Requires kms:create on the configuration, and a current license.

type is AES or RSA. Name algorithm for an exact choice, or leave it out and let key_length or rsa_modulus decide; the defaults are AES-256-GCM and RSA-2048. The reported algorithm is the key length without the cipher mode, so an AES key reads as AES-256 with the mode alongside it in cipher_mode.

usage_mask defaults to ["encrypt", "decrypt"].

A key is not exportable unless private_material_retrievable is set at creation. That decision cannot be made later for a key that was generated without it.

POST

api

kms

create

{proxy}

Generate a KMS key

curl --request POST \
  --url https://{host}/api/v3/kms/create/{proxy} \
  --header 'Content-Type: application/json' \
  --header 'X-Qanapi-Authorization: <api-key>' \
  --data '
{
  "key_length": 256,
  "rsa_modulus": 2048,
  "usage_mask": [],
  "name": "<string>",
  "external_id": "<string>",
  "classification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "classification": "<string>",
  "private_material_retrievable": false,
  "export_window_expires_at": "2023-11-07T05:31:56Z",
  "export_on_create": false,
  "wrap_with_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://{host}/api/v3/kms/create/{proxy}"

payload = {
    "key_length": 256,
    "rsa_modulus": 2048,
    "usage_mask": [],
    "name": "<string>",
    "external_id": "<string>",
    "classification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "classification": "<string>",
    "private_material_retrievable": False,
    "export_window_expires_at": "2023-11-07T05:31:56Z",
    "export_on_create": False,
    "wrap_with_key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "X-Qanapi-Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Qanapi-Authorization': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key_length: 256,
    rsa_modulus: 2048,
    usage_mask: [],
    name: '<string>',
    external_id: '<string>',
    classification_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    classification: '<string>',
    private_material_retrievable: false,
    export_window_expires_at: '2023-11-07T05:31:56Z',
    export_on_create: false,
    wrap_with_key_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://{host}/api/v3/kms/create/{proxy}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/v3/kms/create/{proxy}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key_length' => 256,
    'rsa_modulus' => 2048,
    'usage_mask' => [
        
    ],
    'name' => '<string>',
    'external_id' => '<string>',
    'classification_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'classification' => '<string>',
    'private_material_retrievable' => false,
    'export_window_expires_at' => '2023-11-07T05:31:56Z',
    'export_on_create' => false,
    'wrap_with_key_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Qanapi-Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/v3/kms/create/{proxy}"

	payload := strings.NewReader("{\n  \"key_length\": 256,\n  \"rsa_modulus\": 2048,\n  \"usage_mask\": [],\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"classification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"classification\": \"<string>\",\n  \"private_material_retrievable\": false,\n  \"export_window_expires_at\": \"2023-11-07T05:31:56Z\",\n  \"export_on_create\": false,\n  \"wrap_with_key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Qanapi-Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/api/v3/kms/create/{proxy}")
  .header("X-Qanapi-Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key_length\": 256,\n  \"rsa_modulus\": 2048,\n  \"usage_mask\": [],\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"classification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"classification\": \"<string>\",\n  \"private_material_retrievable\": false,\n  \"export_window_expires_at\": \"2023-11-07T05:31:56Z\",\n  \"export_on_create\": false,\n  \"wrap_with_key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/v3/kms/create/{proxy}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Qanapi-Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key_length\": 256,\n  \"rsa_modulus\": 2048,\n  \"usage_mask\": [],\n  \"name\": \"<string>\",\n  \"external_id\": \"<string>\",\n  \"classification_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"classification\": \"<string>\",\n  \"private_material_retrievable\": false,\n  \"export_window_expires_at\": \"2023-11-07T05:31:56Z\",\n  \"export_on_create\": false,\n  \"wrap_with_key_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "key_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "external_id": "<string>",
  "type": "AES",
  "algorithm": "AES-256",
  "state": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "private_material_retrievable": true,
  "usage_mask": [
    "encrypt"
  ],
  "updated_at": "2023-11-07T05:31:56Z",
  "cipher_mode": "gcm",
  "classification_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "revoke_reason": "<string>",
  "rotated_from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "export_window_expires_at": "2023-11-07T05:31:56Z",
  "export_count": 123,
  "public_key_pem": "<string>",
  "private_key_material": {
    "jwe": "<string>"
  }
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException"
}

{
  "message": "Unauthorized.",
  "error": "InvalidApiKeyException",
  "errors": {
    "type": [
      "The type field is required."
    ],
    "configuration_ids": [
      "No configuration has the id `...`."
    ]
  }
}

Authorizations

X-Qanapi-Authorization

string

header

required

A machine credential, qk_ followed by its secret. Only a hash of the secret is stored, so a key is displayed exactly once, when it is created or rotated. A key reaches only the configurations it is linked to.

It may also be sent as Authorization: Bearer qk_..., which is recognised by the prefix.

Path Parameters

proxy

string

required

The configuration's proxy slug. Sixteen random lowercase letters and digits unless one was pinned at creation.

Example:

"952zpx6vyig3sdyp"

Body

application/json

type

enum<string>

required

Available options:

AES,

RSA

algorithm

enum<string>

An exact choice, and the only way to ask for CBC. Derived from type with key_length or rsa_modulus when omitted.

Available options:

aes-128-gcm,

aes-192-gcm,

aes-256-gcm,

aes-128-cbc,

aes-192-cbc,

aes-256-cbc,

rsa-2048,

rsa-4096

key_length

enum<integer>

default:256

AES only, and ignored when algorithm is given.

Available options:

128,

192,

256

rsa_modulus

enum<integer>

default:2048

RSA only, and ignored when algorithm is given.

Available options:

2048,

4096

usage_mask

enum<string>[]

Defaults to ["encrypt", "decrypt"]. Duplicates are collapsed.

Available options:

encrypt,

decrypt,

sign,

verify

name

string

external_id

string

classification_id

string<uuid>

classification

string

A classification slug, as an alternative to the id.

private_material_retrievable

boolean

default:false

Decide this now. A key generated without it can never be exported, and the setting cannot be granted afterwards.

export_window_expires_at

string<date-time>

After this instant, export is refused even for an exportable key.

export_on_create

boolean

default:false

Return the private half in this response, wrapped to wrap_with_key_id. Requires private_material_retrievable.

wrap_with_key_id

string<uuid>

An existing RSA key to wrap the export to. Required when export_on_create is true.

Response

The new key. private_key_material is present only when export_on_create was set and a wrap key was named.

The compact form returned by the list endpoint.

key_id

string<uuid>

required

How every other KMS endpoint names this key.

name

string | null

required

external_id

string | null

required

A caller's own identifier, for reconciling against another system.

type

enum<string>

required

Available options:

AES,

RSA

algorithm

string

required

The key length, without the cipher mode.

Examples:

"AES-256"

"RSA-2048"

state

enum<string>

required

Available options:

active,

revoked

created_at

string<date-time>

required

private_material_retrievable

boolean

required

Whether the private half may ever leave this service. Fixed at creation: it can be withdrawn later but never granted, because the guarantee made when the key was generated has to keep holding.

usage_mask

enum<string>[]

required

What the key may be used for. Defaults to ["encrypt", "decrypt"] when a key is created without one.

Available options:

encrypt,

decrypt,

sign,

verify

updated_at

string<date-time>

required

cipher_mode

enum<string>

The AES mode. Absent for an RSA key, which has none.

Available options:

gcm,

cbc

classification_id

string<uuid>

Present when the key carries a classification. Decrypting through it then requires the matching clearance.

revoke_reason

string

Present only on a revoked key, and only when one was given.

rotated_from

string<uuid>

The key this one replaced, when it came from a rotation.

export_window_expires_at

string<date-time> | null

After this, export is refused even for an exportable key. Present only on exportable keys.

export_count

integer

How many times the private half has been exported. Present only on exportable keys.

public_key_pem

string

RSA keys only, and always safe to hand out.

private_key_material

object

Present only in the response to an export, or to a create with export_on_create. Never returned by a plain fetch.

Show child attributes

Details

Encryption

Classifications

Policies

Authentication

Users

Configurations

API Keys

Health

KMS

Audit

Transport

Generate a KMS key

Authorizations

Path Parameters

Body

Response