Skip to main content
GET
Get configuration

Authorizations

X-Qanapi-Authorization
string
header
required

A machine credential, qk_ followed by its secret. The first twelve characters are an indexed prefix; the rest is compared in constant time against a stored SHA-256 hash. 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

id
string
required

The configuration's id, or its proxy slug.

Response

The configuration.

id
string<uuid>
required
name
string
required
proxy_slug
string
required

Appears in the URL of every encryption call.

algorithm
string
required
Allowed value: "aes-256-gcm"
mek_provider
string
required

Where the master key lives. local_aek keeps it in the database sealed under the application key; other providers hand custody to an HSM or a cloud KMS.

Example:

"local_aek"

created_at
string<date-time>
required
updated_at
string<date-time>
required
mek_reference
string | null

An HSM handle or key ARN, for providers that use one.