YOLO Vision 2026:

API-Schlüssel#

Ultralytics Platform API-Schlüssel ermöglichen einen sicheren programmatischen Zugriff für Remote-Training, Inferenz und Automatisierung. Erstelle benannte Schlüssel mit AES-256-GCM-Verschlüsselung für verschiedene Anwendungsfälle.

Ultralytics Platform Settings API Keys Tab Key List

API-Key erstellen#

Erstelle einen neuen API-Schlüssel:

  1. Gehe zu Einstellungen > API-Schlüssel
  2. Klicke auf Schlüssel erstellen
  3. Gib einen Namen für den Schlüssel ein (z. B. "Training Server")
  4. Klicke auf Schlüssel erstellen

Ultralytics Platform Settings API Keys Tab Create API Key Dialog

Schlüsselname#

Gib deinem Schlüssel einen beschreibenden Namen:

  • training-server - Für Remote-Training-Maschinen
  • ci-pipeline - Für die CI/CD-Integration
  • local-dev - Für die lokale Entwicklung

Schlüsselanzeige#

Nach der Erstellung wird der Schlüssel in einem Bestätigungsdialog angezeigt:

Ultralytics Platform Settings API Keys Tab API Key Created Copy Dialog

Kopiere deinen Schlüssel

Kopiere deinen Schlüssel direkt nach der Erstellung, um ihn leicht griffbereit zu haben. Schlüssel werden außerdem in der Schlüsselliste angezeigt — die Plattform entschlüsselt und zeigt vollständige Schlüsselwerte an, damit du sie jederzeit kopieren kannst.

Schlüsselformat#

API-Schlüssel folgen diesem Format:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4
  • Präfix: ul_ identifiziert Ultralytics-Schlüssel
  • Körper: 40 zufällige hexadezimale Zeichen
  • Gesamt: 43 Zeichen

Schlüsselsicherheit#

  • Schlüssel werden mit AES-256-GCM-Verschlüsselung gespeichert
  • Die Authentifizierung verwendet einen SHA-256-Hash für ein schnelles indiziertes Nachschlagen
  • Vollständige Schlüsselwerte werden niemals im Klartext gespeichert

Verwendung von API-Schlüsseln#

Umgebungsvariable#

Setze deinen Schlüssel als Umgebungsvariable:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

Validiere und speichere den Key mit der YOLO CLI:

yolo login YOUR_API_KEY

Entferne den gespeicherten Schlüssel mit yolo logout.

HTTP-Header#

Füge den Schlüssel in API-Anfragen ein:

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

Siehe die REST API Reference für alle verfügbaren Endpunkte.

Remote-Training#

Aktiviere das Metrik-Streaming mit deinem Schlüssel.

Installiere oder aktualisiere das Ultralytics-Paket vor dem Start:

pip install -U ultralytics
export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Siehe Cloud Training für die vollständige Anleitung zum Remote-Training.

Schlüssel verwalten#

Schlüssel anzeigen#

Alle Schlüssel werden auf der Registerkarte Settings > API Keys aufgelistet:

Jede Schlüsselkarte zeigt den Namen des Schlüssels, den kopierbaren Schlüsselwert, die relative Erstellungszeit, die Nutzungshäufigkeit und eine Schaltfläche zum Widerrufen.

Schlüssel widerrufen#

Widerrufe einen Schlüssel, der kompromittiert wurde oder nicht mehr benötigt wird:

  1. Finde den Schlüssel im Bereich API-Schlüssel
  2. Klicke auf die Schaltfläche Widerrufen (Papierkorb)
  3. Bestätige den Widerruf
Sofortige Wirkung

Der Widerruf erfolgt sofort. Alle Anwendungen, die den Schlüssel verwenden, funktionieren nicht mehr.

Schlüssel neu generieren#

Falls ein Schlüssel kompromittiert wurde:

  1. Erstelle einen neuen Schlüssel mit demselben Namen
  2. Aktualisiere deine Anwendungen
  3. Widerrufe den alten Schlüssel

Workspace API-Schlüssel#

API-Schlüssel sind auf den aktuell aktiven Workspace beschränkt:

  • Persönlicher Workspace: Schlüssel authentifizieren sich als dein persönliches Konto
  • Team-Workspace: Schlüssel authentifizieren sich im Kontext des Teams

Wenn du in der Seitenleiste den Arbeitsbereich wechselst, zeigt der Abschnitt für API-Schlüssel die Schlüssel für diesen Arbeitsbereich an. Zur Verwaltung von Workspace-API-Schlüsseln ist mindestens die Editor-Rolle erforderlich. Siehe Teams für Details zu den Rollen.

Best Practices für die Sicherheit#

Was du tun solltest#

  • Speichere Schlüssel in Umgebungsvariablen
  • Verwende separate Schlüssel für verschiedene Umgebungen
  • Widerrufe ungenutzte Schlüssel zeitnah
  • Rotiere Schlüssel regelmäßig
  • Verwende beschreibende Namen, um die Zwecke der Schlüssel zu identifizieren

Was du nicht tun solltest#

  • Vermeide das Committen von Schlüsseln in die Versionskontrolle
  • Vermeide das Teilen von Schlüsseln zwischen Anwendungen
  • Vermeide das Protokollieren von Schlüsseln in der Anwendungsausgabe
  • Vermeide das Einbetten von Schlüsseln in clientseitigen Code

Schlüsselrotation#

Rotiere Schlüssel regelmäßig aus Sicherheitsgründen:

  1. Erstelle einen neuen Schlüssel mit demselben Namen
  2. Aktualisiere Anwendungen, um den neuen Schlüssel zu verwenden
  3. Überprüfe, ob die Anwendungen korrekt funktionieren
  4. Widerrufe den alten Schlüssel
Rotationsplan

Erwäge, die Schlüssel für sensible Anwendungen alle 90 Tage zu rotieren.

Fehlerbehebung#

Fehler: Ungültiger Schlüssel#

Error: Invalid API key

Lösungen:

  1. Überprüfe, ob der Schlüssel korrekt kopiert wurde (einschließlich des Präfixes ul_)
  2. Prüfe, ob der Schlüssel widerrufen wurde
  3. Bestätige, dass die Umgebungsvariable gesetzt ist
  4. Stelle sicher, dass du ultralytics>=8.4.104 verwendest

Zugriff verweigert#

Error: Permission denied for this operation

Lösungen:

  1. Überprüfe, ob du der Eigentümer der Ressource bist oder den entsprechenden Workspace-Zugriff hast
  2. Prüfe, ob der Schlüssel zum richtigen Workspace gehört
  3. Erstelle bei Bedarf einen neuen Schlüssel

Ratenbegrenzung#

Error: Rate limit exceeded

Lösungen:

  1. Reduziere die Anfragetrequenz – siehe die rate limit table für Limits pro Endpunkt
  2. Implementiere exponentielles Backoff unter Verwendung des Headers Retry-After
  3. Verwende einen dedicated endpoint, wenn du isolierte Inferenzkapazität benötigst

FAQ#

  • Es gibt kein hartes Limit für API-Schlüssel. Erstelle so viele wie nötig für verschiedene Anwendungen und Umgebungen.

  • Schlüssel laufen nicht automatisch ab. Sie bleiben gültig, bis sie widerrufen werden. Erwäge die Implementierung einer Rotation aus Sicherheitsgründen.

  • Ja, vollständige Schlüsselwerte sind in der Schlüsselliste unter Settings > API Keys sichtbar. Die Platform entschlüsselt und zeigt deine Schlüssel an, damit du sie jederzeit kopieren kannst.

  • Schlüssel funktionieren regionsübergreifend, greifen jedoch nur auf Daten in der Region deines Kontos zu.

  • Bessere Vorgehensweise: Lass jedes Teammitglied seinen eigenen Key erstellen. Für Team-Workspaces kann jedes Mitglied mit der Rolle „Editor“ oder höher Keys erstellen, die auf diesen Workspace beschränkt sind.

Mitwirkende
GLglenn-jocher12SEsergiuwaxmann2LAlaodouya1MYmykolaxboiko1LALaughing-q1

Kommentare