APIキー
Ultralytics Platform APIキーは、リモートトレーニング、推論、自動化のための安全なプログラムによるアクセスを可能にします。異なるユースケース向けに、特定の権限を持つスコープ付きキーを作成できます。
APIキーを作成
新しいAPIキーを作成する：
- 設定 > APIキーに移動します。
- キーを作成をクリックします。
- キーの名前を入力してください
- 権限スコープを選択してください
- 作成をクリックしてください
キー名
キーに分かりやすい名前を付けてください:
training-server- リモートトレーニングマシン用ci-pipeline- CI/CD統合用mobile-app- モバイルアプリケーション用
権限スコープ
キーの権限を制限するためにスコープを選択してください:
| スコープ | 権限 |
|---|---|
| トレーニング | トレーニングの開始、メトリクスのストリーミング |
| モデル | モデルのアップロード、ダウンロード、削除 |
| データセット | データセットへのアクセスと変更 |
| 読み取り | すべてのリソースへの読み取り専用アクセス |
| 書き込み | 完全な書き込みアクセス |
| 管理者 | アカウント管理（慎重に使用してください） |
最小権限
必要な権限のみを持つキーを作成してください。異なるアプリケーションには個別のキーを使用してください。
キー表示
作成後、キーは一度だけ表示されます:
キーをコピー
完全なキーは一度しか表示されません。すぐにコピーして安全に保管してください。後で取得することはできません。
キー形式
APIキーは以下の形式に従います:
ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
- プレフィックス:
ul_Ultralyticsのキーを識別します - ボディ: 40個のランダムな16進数文字
- 合計: 43文字
APIキーの使用
環境変数
キーを環境変数として設定する：
export ULTRALYTICS_API_KEY="ul_your_key_here"
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"
コード内
pythonスクリプトでキーを使用する：
import os
# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")
# Or directly (not recommended for production)
api_key = "ul_your_key_here"
HTTPヘッダー
APIリクエストにキーを含める：
curl -H "Authorization: Bearer ul_your_key_here" \
https://platform.ultralytics.com/api/...
リモートトレーニング
キーを使用してメトリクスストリーミングを有効にする。
パッケージバージョンの要件
Platformとの統合にはultralytics>=8.4.0が必要です。それより低いバージョンはPlatformでは動作しません。
pip install "ultralytics>=8.4.0"
export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1
キーの管理
キーの表示
すべてのキーは、設定 > APIキーに一覧表示されます：
| 列 | 説明 |
|---|---|
| 名前 | キー識別子 |
| スコープ | 割り当てられた権限 |
| 作成 | 作成日時 |
| 最終使用 | 最新の使用 |
キーの取り消し
侵害された、または不要になったキーを失効させる：
- キーのメニューをクリックする
- 失効を選択する
- 失効を確認する
即時適用
失効は即座に適用されます。そのキーを使用しているすべてのアプリケーションは動作を停止します。
キーの再生成
キーが侵害された場合：
- 同じスコープで新しいキーを作成する
- アプリケーションを更新する
- 古いキーを失効させる
セキュリティのベストプラクティス
実行すべきこと
- キーを環境変数に保存する
- 異なる環境には個別のキーを使用する
- 未使用のキーは速やかに失効させる
- 必要最小限のスコープを使用する
- キーを定期的にローテーションする
避けるべきこと
- キーをバージョン管理にコミットする
- アプリケーション間でキーを共有する
- 不必要に管理者スコープを使用する
- アプリケーション出力にキーをログ記録する
- クライアントサイドのコードにキーを埋め込む
キーローテーション
セキュリティのためにキーを定期的にローテーションする:
- 同じスコープで新しいキーを作成する
- 新しいキーを使用するようにアプリケーションを更新する
- アプリケーションが正しく動作することを確認する
- 古いキーを失効させる
ローテーションスケジュール
機密性の高いアプリケーションでは、90日ごとにキーをローテーションすることを検討してください。
トラブルシューティング
無効なキーエラー
Error: Invalid API key
解決策:
- キーが正しくコピーされていることを確認する
- キーが失効していないか確認する
- キーが必要なスコープを持っていることを確認する
- 環境変数が設定されていることを確認する
アクセス拒否
Error: Permission denied for this operation
解決策:
- キーのスコープが必要な権限を含んでいるか確認する
- あなたがリソースの所有者であることを確認する
- 正しいスコープで新しいキーを作成する
レート制限
Error: Rate limit exceeded
解決策:
- リクエスト頻度を減らす
- 指数バックオフを実装する
- 制限の引き上げについてはサポートにお問い合わせください
よくある質問
作成できるキーの数に制限はありますか？
APIキーに厳密な制限はありません。異なるアプリケーションや環境に合わせて必要なだけ作成できます。
キーには有効期限がありますか？
キーは自動的に期限切れになりません。失効されるまで有効です。セキュリティのためにローテーションの実装を検討してください。
キーは作成後に確認できますか？
いいえ、完全なキーは作成時に一度だけ表示されます。紛失した場合は、新しいキーを作成し、古いキーを失効させてください。
キーはリージョン固有ですか？
キーは複数のリージョンで機能しますが、アクセスできるデータはアカウントのリージョン内のデータのみです。
チームメンバーとキーを共有できますか？
より良いプラクティス：各チームメンバーが独自のキーを作成することをお勧めします。これにより、以下のことが可能になります。
- 個々のアクティビティ追跡
- 選択的取り消し
- 適切なアクセス制御
