APIキー
Ultralytics 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の統合ultralytics8.4.0以上が必要です。それより低いバージョンではPlatformと連携しません。
pip install "ultralytics>=8.4.0"
export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo11n.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キーの数に厳密な制限はありません。異なるアプリケーションや環境に応じて、必要な数だけ作成してください。
キーには有効期限がありますか？
キーは自動的に失効しません。取り消されるまで有効です。セキュリティのため、ローテーションの実施をご検討ください。
作成後に自分の鍵を確認できますか？
いいえ、完全な鍵は作成時に一度だけ表示されます。紛失した場合は、新しい鍵を作成し、古い鍵を無効化してください。
キーは地域固有のものですか？
キーはすべてのリージョンで機能しますが、アクセスできるデータはアカウントのリージョン内のみです。
チームメンバーとキーを共有できますか？
より良い方法：各チームメンバーが各自の鍵を作成する。これにより以下のことが可能になる：
- 個人活動追跡
- 選択的取消
- 適切なアクセス制御
