メインコンテンツまでスキップ

API Keys

API Keysページでは、VeloDB Cloud management APIへのプログラム的アクセスのための認証情報を作成・管理できます。API keyの権限は作成時に割り当てられたロールに従い、ウェアハウスへの直接アクセスは含まれません。

api-keys

API keyの作成

右上角の**+ Create API Key**をクリックします。以下のフィールドを持つダイアログが表示されます:

  • Name(必須):後でkeyを識別するのに役立つラベル。
  • Role(必須):keyに割り当てられる権限レベル。
  • Expiration(必須):keyが有効である期間。30 days90 days1 yearCustom(任意の日付を選択)、またはNeverから選択します。

Confirmをクリックしてkeyを生成します。API keyを即座にコピーして安全に保存してください。作成時に一度だけ表示されます。

api-keys-create

既存keyの管理

API Keysリストには、組織内のすべてのkeyが以下の列と共に表示されます:

ColumnDescription
Namekeyに付けたラベル。
Key IDマスクされた識別子(例:key_*****)でコピー可能。
Role作成時に割り当てられたロール。
StatusEnabledまたはDisabled
Last Used最新の成功したAPI呼び出しのタイムスタンプ、または使用されていない場合は
Expires Atkeyが期限切れになる日時。

Actions列では、key毎に3つのコントロールが提供されます:

  • Edit(鉛筆アイコン):keyの名前変更または有効期限の更新。
  • Enable / Disable(トグル):keyを削除せずに一時的にアクセスをブロックまたは復元。
  • Delete(ゴミ箱アイコン):keyを完全に削除。この操作は元に戻せません。

セキュリティチェックリスト

  1. API keyが意図した管理タスクを実行するのに必要な最小権限のロールを割り当てます。
  2. 組織が無期限keyを承認していない限り、有効期限を設定します。
  3. API keyを即座に承認されたシークレット管理ツールに保存します。keyは作成時に一度だけ表示され、後で取得することはできません。
  4. Last UsedExpires Atを定期的に確認します。一時的にアクセスを取り消すにはkeyを無効化し、不要になった場合のみ削除します。

Management APIの使用

利用可能なエンドポイントの完全なリスト、リクエスト/レスポンススキーマ、インタラクティブな例については、VeloDB Cloud Management API Referenceを参照してください。