APIキー

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

APIキーの作成

新しいAPIキーを作成する：

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

キー名

キーに説明的な名前を付けます：

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

キーの表示

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

キーの形式

APIキーは次の形式に従います：

• プレフィックス: ul_ はUltralyticsキーであることを識別します
• ボディ: 40文字のランダムな16進数
• 合計: 43文字

キーのセキュリティ

• キーは AES-256-GCM暗号化 で保存されます
• 認証にはSHA-256ハッシュを使用して、高速なプレフィックス検索とハッシュ比較を行います
• キーの完全な値は、プレーンテキストでは一切保存されません

APIキーの使用

環境変数

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

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI

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

yolo settings api_key="YOUR_API_KEY"

コード内

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"

HTTPヘッダー

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

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

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

リモートトレーニング

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

pip install "ultralytics>=8.4.35"

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

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

キーの管理

キーの表示

すべてのキーは Settings > API Keys タブにリストされます：

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

キーの取り消し

侵害された、または不要になったキーを取り消します：

1. API Keysセクションで該当するキーを見つけます
2. Revoke（ゴミ箱）ボタンをクリックします
3. 取り消しを確認します

キーの再生成

キーが侵害された場合：

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

ワークスペースAPIキー

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

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

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

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

推奨事項

• キーは環境変数に保存してください
• 環境ごとに異なるキーを使用してください
• 不要になったキーは速やかに取り消してください
• 定期的にキーをローテーションしてください
• キーの目的を特定するために説明的な名前を使用してください

禁止事項

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

キーのローテーション

セキュリティのため、定期的にキーをローテーションしてください：

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

トラブルシューティング

無効なキーエラー

解決策：

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

権限拒否

解決策：

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

レート制限

解決策：

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

FAQ

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

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

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

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

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

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

キーはリージョン固有ですか？

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

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

推奨される実践：各チームメンバーが独自のキーを作成するようにしてください。チームワークスペースの場合、エディター以上の権限を持つ各メンバーが、そのワークスペースのスコープでキーを作成できます。