Keyring and Data Encryption Reference

/keyring

Response

    "active": "RfsDJ2Ol",
    "ids": [
        "xSD219lH"
    ]
}

View Active Key

Endpoint

/keyring/active

Response

HTTP 200 OK

{
    "id": "RfsDJ2Ol"
}

Export Keyring

This endpoint is only available with the cluster keyring strategy.

The endpoint requires that the keyring_public_key and keyring_private_key Kong configuration values are defined.

Endpoint

/keyring/export

Response

{
    "data": "<base64>..."

This endpoint is only available with the cluster keyring strategy.

The endpoint requires that the keyring_public_key and keyring_private_key Kong configuration values are defined.

Endpoint

Request Body

Response

HTTP 201 Created

Import Key

This endpoint is only available with the cluster keyring strategy.

The endpoint requires that the keyring_public_key and keyring_private_key Kong configuration values are defined.

Endpoint

/keyring/import/raw

Request Body

Response

HTTP 201 Created

Recover Keyring from Database

This endpoint is only available with the cluster keyring strategy.

The endpoint requires that the keyring_recovery_public_key Kong configuration value is defined.

Endpoint

/keyring/recover

Request Body

    "recovered": [
        "RfsDJ2Ol"
    ],
    "not_recovered": [
        "xSD219lH"
    ]
}

This endpoint is only available with the cluster keyring strategy.

Endpoint

/keyring/generate

Response

HTTP 201 Created

{
    "id": "500pIquV",
    "key": "3I23Ben5m7qKcCA/PK7rnsNeD3kI4IPtA6ki7YjAgKA="

Remove Key from Keyring

This endpoint is only available with the cluster keyring strategy.

Endpoint

/keyring/remove

Request Body

Response

Sync Keyring with Vault Endpoint

This endpoint is only available with the keyring strategy.

Endpoint

/keyring/vault/sync

Response

HTTP 204 No Content