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キーは以下のフォーマットに従います：

• プレフィックス: ul_ はUltralyticsキーであることを識別します
• ボディ: 40文字のランダムな16進数文字
• 合計: 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 Referenceを参照してください。

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 sectionFAQ#

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

APIキーの作成数に制限はありません。異なるアプリケーションや環境のために必要な数だけ作成してください。

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

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

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

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

Link to this sectionキーはリージョン固有ですか？#

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

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

ベストプラクティス：各チームメンバーに自身のキーを作成してもらいましょう。チームワークスペースの場合、エディター以上の権限を持つ各メンバーが、そのワークスペースにスコープされたキーを作成できます。