旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

キーリングとデータ暗号化のリファレンス

キーリングを表示

エンドポイント

/keyring

レスポンス

HTTP 200 OK

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

アクティブキーの表示

エンドポイント

/keyring/active

レスポンス

HTTP 200 OK

{
    "id": "RfsDJ2Ol"
}

キーリングのエクスポート

このエンドポイントは、 clusterキーリング戦略でのみ使用できます。

エンドポイントでは、keyring_public_keyおよびkeyring_private_keyのKong構成値が定義されている必要があります。

エンドポイント

/keyring/export

レスポンス

HTTP 200 OK

{
    "data": "<base64 id="sl-md0000000">..."
}

エクスポートされたキーリングのインポート

このエンドポイントは、 clusterキーリング戦略でのみ使用できます。

エンドポイントでは、keyring_public_keyおよびkeyring_private_keyのKong構成値が定義されている必要があります。

エンドポイント

/keyring/import

リクエストボディ

属性	説明
`data`	Base64でエンコードされた鍵束のエクスポートマテリアル。

レスポンス

HTTP 201 Created

インポートキー

このエンドポイントは、 clusterキーリング戦略でのみ使用できます。

エンドポイントでは、keyring_public_keyおよびkeyring_private_keyのKong構成値が定義されている必要があります。

エンドポイント

/keyring/import/raw

リクエストボディ

属性	説明
`id`	8バイトのキー識別子。
`data`	Base64でエンコードされた鍵束のエクスポートマテリアル。

レスポンス

HTTP 201 Created

データベースからのキーリングの回復

このエンドポイントは、 clusterキーリング戦略でのみ使用できます。

エンドポイントでは、keyring_recovery_public_keyのKong構成値が定義されている必要があります。

エンドポイント

/keyring/recover

リクエストボディ

属性	説明
`recovery_private_key`	秘密鍵の内容。

レスポンス

HTTP 200 OK

{
    "message": "successfully recovered 1 keys",
    "recovered": [
        "RfsDJ2Ol"
    ],
    "not_recovered": [
        "xSD219lH"
    ]
}

キーを新規生成

このエンドポイントは、 clusterキーリング戦略でのみ使用できます。

エンドポイント

/keyring/generate

レスポンス

HTTP 201 Created

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

キーリングからキーを削除

このエンドポイントは、 clusterキーリング戦略でのみ使用できます。

エンドポイント

/keyring/remove

リクエストボディ

属性	説明
`key`	8バイトのキー識別子。

レスポンス

HTTP 204 No Content

キーリングをVault Endpointと同期する

このエンドポイントは、 vaultキーリング戦略でのみ使用できます。

エンドポイント

/keyring/vault/sync

レスポンス

HTTP 204 No Content