YOLO Vision 2026:

APIキー#

Ultralytics Platform APIキーを使用すると、リモートトレーニング、推論、自動化のための安全なプログラムアクセスが可能になります。AES-256-GCM暗号化を使用して、用途ごとに名称付きのキーを作成できます。

Ultralytics Platform Settings API Keys Tab Key List

APIキーの作成#

新しいAPIキーの作成方法:

  1. Settings > API Keysに移動します
  2. Create Keyをクリックします
  3. キーの名前を入力します（例: "Training Server"）
  4. Create Keyをクリックします

Ultralytics Platform Settings API Keys Tab Create API Key Dialog

キー名#

キーに分かりやすい名前を付けます:

  • training-server - リモートトレーニングマシン用
  • ci-pipeline - CI/CD統合用
  • local-dev - ローカル開発用

キーの表示#

作成後、キーは確認ダイアログに表示されます。

Ultralytics Platform Settings API Keys Tab API Key Created Copy Dialog

キーのコピー

後で簡単に参照できるよう、作成時にキーをコピーしてください。キーはキーリストにも表示されます。プラットフォームが完全なキー値を復号して表示するため、いつでもコピーできます。

キーのフォーマット#

APIキーは以下のフォーマットに従います:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4
  • Prefix: ul_ はUltralyticsキーであることを識別します
  • Body: 40文字のランダムな16進数
  • Total: 43文字

キーのセキュリティ#

  • キーはAES-256-GCM暗号化で保存されます
  • 認証には高速なインデックス検索のためのSHA-256ハッシュが使用されます
  • 完全なキーの値はプレーンテキストでは保存されません

APIキーの使用#

環境変数#

キーを環境変数として設定します:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

YOLO CLIを使用してキーを検証し保存します。

yolo login YOUR_API_KEY

yolo logoutで保存されたキーを削除します。

HTTPヘッダー#

APIリクエストにキーを含めます:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

利用可能なすべてのエンドポイントについては、REST APIリファレンスを参照してください。

リモートトレーニング#

キーを使用してメトリクスのストリーミングを有効にします。

開始する前にUltralyticsパッケージをインストールまたは更新してください。

pip install -U ultralytics
export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

リモートトレーニングの完全なガイドについては、Cloud Trainingを参照してください。

キーの管理#

キーの表示#

すべてのキーはSettings > API Keysタブに一覧表示されます:

各キーカードには、キー名、コピー可能なキー値、相対的な作成時間、使用回数、および無効化ボタンが表示されます。

キーの取り消し#

侵害されたキーや不要になったキーを取り消します:

  1. API Keysセクションで対象のキーを探します
  2. Revoke（ゴミ箱）ボタンをクリックします
  3. 取り消しを確定します
即時反映

取り消しは即座に反映されます。そのキーを使用しているアプリケーションは動作しなくなります。

キーの再生成#

キーが侵害された場合:

  1. 同じ名前で新しいキーを作成します
  2. アプリケーションを更新します
  3. 古いキーを取り消します

ワークスペースAPIキー#

APIキーは現在アクティブなワークスペースにスコープされます:

  • 個人ワークスペース: キーは個人アカウントとして認証されます
  • チームワークスペース: キーはチームコンテキスト内で認証されます

サイドバーでワークスペースを切り替えると、API Keysセクションにはそのワークスペースのキーが表示されます。ワークスペースのAPIキーを管理するには、エディター以上のロールが必要です。ロールの詳細についてはTeamsを参照してください。

セキュリティのベストプラクティス#

行うこと#

  • キーは環境変数に保存する
  • 環境ごとに別々のキーを使用する
  • 使用していないキーは速やかに取り消す
  • 定期的にキーをローテーションする
  • 目的を識別しやすい名前を付ける

行わないこと#

  • キーをバージョン管理にコミットしない
  • アプリケーション間でキーを共有しない
  • アプリケーションの出力にキーをログ出力しない
  • クライアント側のコードにキーを埋め込まない

キーのローテーション#

セキュリティのため、定期的にキーをローテーションします:

  1. 同じ名前で新しいキーを作成する
  2. 新しいキーを使用するようにアプリケーションを更新する
  3. アプリケーションが正常に動作することを確認する
  4. 古いキーを取り消す
ローテーションスケジュール

機密性の高いアプリケーションの場合は、90日ごとのキーローテーションを検討してください。

トラブルシューティング#

無効なキーのエラー#

Error: Invalid API key

解決策:

  1. キーが正しくコピーされていることを確認する（ul_プレフィックスを含む）
  2. キーが取り消されていないことを確認する
  3. 環境変数が設定されていることを確認する
  4. ultralytics>=8.4.104を使用していることを確認してください。

権限拒否#

Error: Permission denied for this operation

解決策:

  1. リソースの所有者であるか、適切なワークスペースアクセス権を持っているかを確認する
  2. キーが正しいワークスペースに属しているか確認する
  3. 必要に応じて新しいキーを作成する

レート制限#

Error: Rate limit exceeded

解決策:

  1. リクエスト頻度を下げる — エンドポイントごとの制限についてはレート制限表を参照してください
  2. Retry-Afterヘッダーを使用して指数バックオフを実装する
  3. 独立した推論キャパシティが必要な場合は、専用エンドポイントを使用してください。

よくある質問 (FAQ)#

キーは何個まで作成できますか？#

APIキーの作成数にハードリミットはありません。用途や環境に合わせて必要な数だけ作成してください。

キーに有効期限はありますか？#

キーは自動的には期限切れになりません。取り消されるまで有効です。セキュリティのためにローテーションの導入を検討してください。

作成後にキーを確認できますか？#

はい、完全なキー値はSettings > API Keysのキーリストで確認できます。プラットフォームがキーを復号して表示するため、いつでもコピー可能です。

キーは地域固有のものですか？#

キーはリージョンをまたいで機能しますが、アカウントのリージョン内のデータのみにアクセスできます。

キーをチームメンバーと共有できますか？#

推奨される方法：各チームメンバーが独自のキーを作成するようにしてください。チームワークスペースの場合、Editor以上のロールを持つ各メンバーが、そのワークスペースにスコープされたキーを作成できます。

コントリビューター
GLglenn-jocher12SEsergiuwaxmann2LAlaodouya1MYmykolaxboiko1LALaughing-q1

コメント