Skip to Content
APIリファレンスAPIキーAPIキーの再生成

APIキーの再生成

POST/console/v1/accounts/{accountId}/projects/{projectId}/keys/{keyId}/rotate

APIキーの値を新しく生成します。 APIキーのID、有効期限、設定は変わりません。 再生成は、次の2つの手順で行います。

  1. このAPIを呼び出して、レスポンスの key.key(APIキーの新しい値)を保存する。
  2. 60分以内に発行・再生成の確定を呼び出す。確定すると、新しい値を利用できる。

応答を受け取れなかった場合は、同じ operationId と attemptId のまま、recovery に true を指定して再送します。

認証

Authorizationstring必須

Bearer <マネジメントトークン> の形式で指定します。 詳しくは認証を参照してください。

パスパラメーター

accountIdstring必須

組織のID。 コンソールのURLの /accounts/ に続く部分です。

projectIdstring必須

プロジェクトのID。 プロジェクト一覧の projectId で取得できます。

keyIdstring必須

APIキーのID。 APIキー一覧の keyId で取得できます。

リクエストボディ

operationIdstring必須

この操作を識別するためのID。 550e8400-e29b-41d4-a716-446655440000 のような形式のID(UUID)を、自分で生成して指定します。 確定するときに、URLに指定します。

attemptIdstring必須

確定するときの照合に使うID。 UUIDを自分で生成して指定します。 確定するときに、同じ値をリクエストボディに指定します。

recoveryboolean必須

再送かどうか。 最初のリクエストでは false、応答を受け取れずに再送する場合は true を指定します。

レスポンス

operationIdstring

リクエストで指定した値。

attemptIdstring

リクエストで指定した値。

keyobject

再生成したAPIキー。

フィールドを表示フィールドを非表示
keystring

APIキーの新しい値。 このレスポンスでのみ取得できます。

keyIdstring

APIキーのID。

keyAliasstring

APIキーの名前。

projectIdstring

プロジェクトのID。

ruleIdstring | null

適用しているルールのID。

expiresAtstring

有効期限(ISO 8601)。

blockedboolean

無効にしているかどうか。

spendMicroJpyinteger | null

利用額。 円の金額を1,000,000倍した整数です。 APIキー一覧でのみ値が入ります。

budgetDurationstring | null

予算の期間。 day、week、month のいずれかです。

nextBudgetResetAtstring | null

次に予算がリセットされる日時。

maxBudgetMicroJpyinteger | null

予算の上限。 円の金額を1,000,000倍した整数で指定します(例:5,000円は 5000000000)。

rpmLimitinteger | null

1分あたりのリクエスト数(RPM)の上限。

tpmLimitinteger | null

1分あたりのトークン数(TPM)の上限。

modelsstring[]

利用を許可するモデルのID(UUID)の配列。 推論APIの model に指定するIDとは異なります。 空の場合は、組織で許可されているすべてのモデルを利用できます。

autoCandidatesstring[]

model に auto を指定したときに、候補にするモデルのID(UUID)の配列。

routingStrategystring | null

auto の候補から選ぶ方法。 cheapest を指定すると、価格の安い順に選びます。

fallbackModelsstring[]

指定したモデルが応答できない場合に、代わりに試すモデルのID(UUID)の配列。 詳しくはフォールバックを参照してください。

forceAutoboolean

auto 以外のモデルの指定を拒否するかどうか。

guardrailsarray

リクエストをモデルへ送る前に行う検査(ガードレール)。 pii_mask(個人情報の置き換え)、prompt_injection(プロンプトインジェクションの拒否)を指定できます。 詳しくはガードレールを参照してください。

individualSettingsobject

このAPIキーに個別に指定した設定。

settingSourcesobject

設定ごとの値の出どころ。 rule(ルール)、individual(個別の指定)、default(デフォルト値)のいずれかです。

エラー

エラーの形式はエラーを参照してください。

ステータスコードerror原因
400bad_requestリクエストボディの形式や値が正しくない
401console_authentication_failedマネジメントトークンが正しくない、または有効期限が切れている
403console_authorization_denied操作する権限がない、または組織やプロジェクトが有効な状態ではない
404not_foundリソースが見つからない、またはIDの形式が正しくない
409key_provisioning_conflict同じ operationId の操作がすでにある、または attemptId が一致しない
503console_keys_unavailableサービスが一時的に利用できない