Link to this sectionAPIキー#

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

Link to this sectionAPIキーの作成#

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

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

Link to this sectionキー名#

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

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

Link to this sectionキーの表示#

作成後、キーは一度だけ表示されます:

Link to this sectionキーのフォーマット#

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

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

Link to this sectionキーのセキュリティ#

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

Link to this sectionAPIキーの使用#

Link to this section環境変数#

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

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

Link to this sectionYOLO CLI#

YOLO CLIを使用してキーを設定します:

yolo settings api_key="YOUR_API_KEY"

Link to this sectionコード内での利用#

Pythonスクリプトでキーを使用します:

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

Link to this sectionHTTPヘッダー#

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

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

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

Link to this sectionリモートトレーニング#

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

pip install "ultralytics>=8.4.60"

export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

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

Link to this sectionキーの管理#

Link to this sectionキーの表示#

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

各キーカードには、キー名、復号された完全なキー値（コピー可能）、相対的な作成時間、および取り消しボタンが表示されます。

Link to this sectionキーの取り消し#

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

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

Link to this sectionキーの再生成#

キーが侵害された場合:

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

Link to this sectionワークスペースAPIキー#

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

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

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

Link to this sectionセキュリティのベストプラクティス#

Link to this section行うこと#

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

Link to this section行わないこと#

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

Link to this sectionキーのローテーション#

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

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

Link to this sectionトラブルシューティング#

Link to this section無効なキーのエラー#

解決策:

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

Link to this section権限拒否#

解決策:

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

Link to this sectionレート制限#

解決策:

1. リクエスト頻度を下げる — エンドポイントごとの制限についてはレート制限表を参照してください
2. Retry-Afterヘッダーを使用して指数バックオフを実装する
3. 無制限の推論スループットには専用エンドポイントを使用する

Link to this sectionよくある質問 (FAQ)#

Link to this sectionキーは何個まで作成できますか？#

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

Link to this sectionキーに有効期限はありますか？#

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

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

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

Link to this sectionキーは地域固有のものですか？#

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

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

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