Skip to Content
APIリファレンスAPIキーAPIキーの無効化

APIキーの無効化

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

APIキーを無効にします。 無効にしたAPIキーでは、推論APIを呼び出せません。 APIキーの有効化で元に戻せます。

認証

Authorizationstring必須

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

パスパラメーター

accountIdstring必須

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

projectIdstring必須

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

keyIdstring必須

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

レスポンス

keyobject

無効にした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原因
401console_authentication_failedマネジメントトークンが正しくない、または有効期限が切れている
403console_authorization_denied操作する権限がない、または組織やプロジェクトが有効な状態ではない
404not_foundリソースが見つからない、またはIDの形式が正しくない
503console_keys_unavailableサービスが一時的に利用できない