メインコンテンツまでスキップ
バージョン: 4.x

API Keys

API Keysを使用すると、VeloDB Cloud management APIへのプログラマティックアクセス認証情報を作成および管理できます。API keyの権限は作成時に割り当てられたロールに従います。直接のデータベースアクセスは含まれません。

api-keys

API keyを作成する

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

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

Confirmをクリックしてキーを生成します。キーの値を即座にコピーして保存してください — 一度のみ表示されます。

api-keys-create

既存のキーを管理する

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

説明
Nameキーに付けたラベル。
Key IDマスクされた識別子(例:sk-b****V59R)をコピーできます。
Role作成時に割り当てられたロール。
StatusEnabledまたはDisabled
Last Used最新の成功したAPI呼び出しのタイムスタンプ、または使用されたことがない場合は
Expires Atキーの有効期限の日時。

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

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

Management APIを使用する

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