For the complete documentation index, see llms.txt. This page is also available as Markdown.

APIキーをローテーションする

Roboflow APIキーをいつローテーションするか、ローテーション前にそのキーがどこで使われているかを見つける方法、Rollの仕組み、そしてローテーションのリマインダーの仕組みについて説明します。

APIキーをロールすると、そのシークレット値が新しいものに置き換わります。古い値のまま保持しているものはすべてアクセス権を失います。

Roboflow では、キーはおよそ年に1回ロールすることを推奨しています。これはガイドラインであり、必須ではありません。1年という間隔は、Roboflow を使う組織のセキュリティポリシーに由来しており、キーはロールの日付を過ぎても引き続き動作します。ロールのリマインダーは侵害の兆候ではありません。

キーが露出した場合(例: 公開リポジトリにコミットされた、チャットに貼り付けられた、チームを離れた人物が保持していた)には、すぐにロールしてください。露出したキーは生きたままにしてはいけません。直ちにロールまたは失効させ、停止は受け入れたうえで、利用側を修正してください。保護されたキーはロールも失効もできないため、まずダッシュボードで保護を解除してください。

キーがどこで使われているかを見つける

ロールの難しい部分は、そのキーに何が依存しているかを把握することです。未知のシステムが使っているキーをロールすると、そのシステムは停止します。まず次のソースを確認してください:

  • キー表にあるキーの名前とメタデータです。利用先にちなんだ名前(例: "line-3-camera-gateway")で、メタデータに所有者が入っているキーが最も追跡しやすいです。参照: カスタムメタデータ.

  • 依存関係の警告です。"Roll"、"Revoke"、または "Disable" をクリックすると、ダイアログには Roboflow がそのキーに依存していると把握しているものが一覧表示されます。専用デプロイ、請求フォルダー、エッジデバイス、ワークスペースのデフォルトキーかどうか、直近30日間に課金対象の使用があったかどうか、などです。参照: 依存関係の警告.

  • 監査ログです。これは、そのキーで行われた管理イベントと書き込みイベントを記録しますが、推論や読み取りトラフィックは記録しません。そのため、キーが何に使われたかの一部が分かります。参照: 監査ログと SIEM エクスポート.

  • 利用状況レポートです。課金対象の使用量はキーごとに割り当てられるため、最近の使用状況を見るとその時点でキーが使われていたことは分かりますが、その後利用先が移動している可能性があります。課金対象でない呼び出しは表示されません。参照: 請求フォルダー.

  • 自分で管理している台帳: 環境ファイル、シークレットマネージャー、CI 変数、Docker コマンド、手作業でプロビジョニングしたデバイス。

そのキーがエッジデバイスまたは Workflow からの推論だけを実行する場合、これらのデバイスが新しい値を受け取った後であればロールのリスクは低いです。チーム内でそのキーの用途を誰も言えない場合は、ロールするのではなく新しいキーを作成して移行してください。

キーをロールする

"Roll" は、キーを失効させると同時に、その置き換えを1ステップで作成します。新しいキーは、古いキーの名前、権限、フォルダー、メタデータ、無効状態を引き継ぎます。古いキーで動作している専用デプロイは自動的に新しいキーへ移行します。移行できないものが1つでもあると、ロールは "The API key was not rolled" というエラーで失敗し、古いキーは有効のまま残り、同じ名前の置き換えキーがすでに作成されている場合もあるため、再試行する前にキー一覧を確認してください。それ以外はすべて、新しい値で更新するまで失敗します。

切り替えの停止時間を短くできる場合や、キーが露出して今すぐ動作を止める必要がある場合に Roll を使ってください。露出したキーが専用デプロイを支えている場合は、ロールに頼らないでください。まずデプロイに別のキーを与え、その後ダッシュボードから古いキーを失効させてください。そうするとデプロイは一時停止します。

1

キー表を開きます。ワークスペースのキーは、設定の "API Keys" にあります。フォルダーのキーは、フォルダーカードのメニューの "API Keys" にあります。

2

キーの行にある "Roll" アイコンをクリックします。依存関係の警告を読みます。何か表示された場合は、確認用チェックボックスにチェックを入れます。

3

"I Understand, Roll This API Key" をクリックします。行がハイライトされ、"New" と表示されます。新しい値をコピーします。

4

すべての利用先を新しい値に更新し、再起動が必要なものは再起動します。

5

今後数時間は、利用先のログとヘルスチェックで認証エラー(401 と 403)を監視してください。Roboflow は失効したキーに対して拒否された呼び出しを記録しないため、利用先の見落としを示す唯一の手がかりは自分の監視です。

保護されたキーはロールできません。まず保護を解除してください。参照: キーを保護する.

スクリプトやエージェントからロールするには、 roboflow api-key roll、REST API、または MCP Server を使用します。参照: APIキーをロールする.

Roll API Key dialog with a dependency warning listing a Dedicated Deployment and the workspace default, and the confirmation checkbox
まだ使用中のキーで "Roll API Key" を実行すると、警告には専用デプロイとワークスペースのデフォルトが表示され、確認にチェックを入れるまでロールは無効のままです。

新しいキーを作成して移行する

2つの有効なキーがあれば、利用先を1つずつ移行でき、最後の1つが切り替わるまで古いキーを予備として残せます。この方法は計画的なローテーションにのみ使い、露出したキーには絶対に使わないでください。

1

"Generate New Key" をクリックし、新しいキーに古いキーと同じ権限とフォルダーを付与します。利用先にちなんだ名前を付けてください。

2

新しい値で利用先を1つずつ更新します。

3

すべての利用先が新しいキーで動作するようになったら、古いキーを失効させます。依存関係の警告は移行完了を確認できません。直近30日間の課金対象使用をフラグするため、先週移行を終えたキーでも表示されますし、課金対象でない呼び出しは表示されません。失効させる前に、各利用先を自分で確認してください。

誰がキーをロールできるか

キーをロールするには、"Create Api Key" と "Revoke Api Key" の権限が必要で、キーが保護されている場合は "Update Api Key" も必要です。ワークスペースのキーについては、メンバーに "View Workspace API Keys" も必要です。フォルダーのキーについては、そのフォルダーへの書き込み権限が必要です。参照: ロールベースアクセス制御.

各キーをロールできる人を少なくとも2人は確保しておき、ローテーションが退職者待ちにならないようにしてください。 推奨アクセス設定 は、これを実現するロール構成を説明しています。

ローテーションのリマインダー

ローテーションのリマインダーは、 Advanced API Keysの一部であり、Enterprise のアドオンです。 営業担当にお問い合わせください またはアカウント担当者に連絡して有効化してください。

キーに "Rotation Due Date" が設定されている場合にのみ、リマインダーが届きます。キー作成時または "Edit" から日付を設定してください。"Suggest One Year" を使うと、1年後の日付が自動入力されます。リマインダーを止めるには日付を消してください。

"Owners" は、そのキーについてメールを受け取るメンバーです。キーをロールできるメンバーだけが所有者になれます。リストを空にすると、ロールできる全員にメールが送られます。所有者の誰ももうキーをロールできない場合(例: ワークスペースを離れた場合)は、理由を添えて、ロールできる全員にメールが送られます。"Generate New API Key" ダイアログでは、所有者としてあなたがあらかじめ選択されています。全員にメールを送るには、その欄を空にしてください。

メールはアクティブなキーごとに1回、期限日の15日前から期限日当日までのどこかの日に送信されます。これより近い日付に設定された場合は、翌日にリマインドされることがあります。その期間中に無効化されたキーにはリマインダーは送られず、期限日を過ぎてから有効化しても何も送信されません。また、請求制限のあるワークスペースにはリマインダーは一切送られません。期限日になってもキーに対して何も起こらず、引き続き動作します。

キー表には、各日付までの近さが表示されます。日付付きで "Rotate by"、30日前からは "Due in"、当日は "Due today"、その後は "Overdue" です。"Show only keys due for rotation" を使うと、日付から30日以内のキー、または期限超過のキーに表が絞り込まれます。日付のないキーには "No Rotation Date" と表示されます。

キーをロールすると、そのキーが持っていた期限日は、最大1年まで、もともとの間隔と同じだけ前倒しされるため、予定どおりローテーションされたキーは予定どおりのままです。作成日の記録がないキーはロールしても日付がそのまま残るため、ロール時に新しい日付を設定してください。

Key table with Due in, Rotate by and No Rotation Date badges
キー表のローテーションバッジです。2日後が期限のキーは日付から30日以内なので、"Show only keys due for rotation" では1件として数えられます。一方、1年後が期限のキーには "Rotate by" と表示されます。

最終更新

役に立ちましたか?