YOLO Vision 2026:

APIキー#

Ultralytics PlatformのAPIキーを使用すると、リモート学習、推論、自動化のための安全なプログラムによるアクセスが可能になります。異なるユースケースに合わせて、AES-256-GCM暗号化を使用した名前付きキーを作成できます。

Ultralytics Platform Settings API Keys Tab Key List

オーナー限定

ワークスペースのAPI keysを作成、表示、または無効化できるのはワークスペースのオーナーのみです。これは、キーがワークスペースのオーナーとして認証を行うためです。その他のロールを持つメンバーには、キーリストの代わりにタブ上にメモが表示されます。API keys自体で他のAPI keysを作成または無効化することはできません。唯一の例外はOn Premise worker keysであり、これらはホストをOn Premiseのインテグレーションから切断することで無効化されます。

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
  • プレフィックス: ul_ はUltralyticsのキーを識別します
  • Body: 40文字のランダムな16進数
  • Total: 43文字

キーのセキュリティ#

  • キーは平文ではなく、AES-256-GCM encryptionで保存されます
  • 最初の11文字（ul_と8文字の16進数）がディスプレイプレフィックスとして機能するため、キーを露出させずに識別できます

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/...

または、Python SDK（pip install "ultralytics-platform>=0.1.5"）に渡します。これには ULTRALYTICS_API_KEY も読み込まれます。

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

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

リモートトレーニング#

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

開始する前に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セクションにはそのワークスペースのキーが表示されます。ワークスペースのキーにはオーナー権限が付与されているため、作成、表示、または無効化できるのはワークスペースのオーナーのみです。ロールの詳細については、Teamsを参照してください。

On Premise Worker Keys#

On Premiseのホストを接続すると、個別のワーカーキーが発行されます。ワーカーキーはこのタブではなくOn Premiseインテグレーションから管理され、API keysと一緒にリストされることはありません。また、ホストを切断すること（これによりそのホストのキューに登録されたジョブや実行中のジョブもキャンセルされます）によって無効化されます。

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

行うこと#

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

行わないこと#

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

キーのローテーション#

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

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

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

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

無効なキーのエラー#

Error: Invalid API key

解決策:

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

権限拒否#

Error: Permission denied for this operation

解決策:

  1. リソースの所有者であるか、適切なワークスペースアクセス権を持っているかを確認する
  2. キーが正しいワークスペースに属しているか確認する
  3. チームワークスペースでキーを管理している場合は、自分がワークスペースのオーナーであることを確認してください。他のロールではWorkspace owner access requiredが表示されます
  4. 必要に応じて新しいキーを作成する

レート制限#

Error: Rate limit exceeded

解決策:

  1. リクエスト頻度を削減してください。カテゴリごとの制限についてはrate limit tableを参照してください
  2. Retry-After ヘッダーを使用して指数バックオフを実装します
  3. 独立した推論キャパシティが必要な場合は、dedicated endpointを使用してください

よくある質問 (FAQ)#

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

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

  • はい、キーの値全体が Settings > API Keys のキーリストに表示されます。プラットフォームがキーを復号して表示するため、いつでもコピーできます。

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

  • いいえ。チームワークスペースのキーはワークスペースのオーナーとして認証されるため、作成または表示できるのはオーナーのみであり、キーを共有するとオーナー権限を引き渡すことになります。各メンバーに自身のパーソナルワークスペースでキーを作成してもらい、CIなどの共有自動化用にはオーナーに専用のワークスペースキーを発行してもらうようにしてください。

  • いいえ。キーは作成されたワークスペースに属し、そのワークスペースのリソースにのみアクセスします。自動化するワークスペースごとに個別のキーを作成してください。

貢献者
GLglenn-jocher14SEsergiuwaxmann2LAlaodouya1MYmykolaxboiko1LALaughing-q1

コメント