Ein Fleet API-Schlüssel ermöglicht es dir, direkt mit deiner Fleet-Instanz zu kommunizieren. Verwende einen, um Skripte auszuführen, Gerätedaten abzurufen oder Fleet mit anderen Tools zu verbinden.

Funktion/Feature

Überblick

Fleet (FleetDM) API-Schlüssel authentifizieren Anfragen, die direkt an deine Fleet-Instanz gesendet werden. Du kannst sie auf drei Arten erstellen:

• Von Factorial IT, als schreibgeschützter Schlüssel.
• Vom Fleet-Dashboard, als Token, das mit deinem Fleet-Benutzerkonto verknüpft ist.
• Von der Kommandozeile, mit dem Fleet CLI oder der Fleet API.

Fleet API-Token laufen niemals von selbst ab.

So verwendest du: Erstelle einen Schlüssel von Factorial IT

1. Gehe zu Einstellungen > Entwickler und scrolle nach unten zum Abschnitt FleetDM API-Schlüssel.
2. Gib einen Schlüsselnamen ein, zum Beispiel das Tool, das den Schlüssel verwenden wird.
3. Klicke auf Schlüssel generieren.
4. Kopiere das Token, das im Fenster FleetDM API-Schlüssel erstellt angezeigt wird. Es bleibt danach in der Schlüsseltabelle verfügbar.

Schlüssel, die von Factorial IT erstellt wurden, sind schreibgeschützt. Sie können jedes Gerät und dessen Daten sehen, aber sie können keine Einstellungen ändern oder Geräteaktionen ausführen. Sie eignen sich für externe Integrationen, die nur deine Fleet-Instanz lesen müssen.

Um einen zu widerrufen, öffne das ⋯ Menü in seiner Zeile in der FleetDM API-Schlüssel Tabelle und klicke auf Widerrufen. Jede Integration, die ihn verwendet, hört sofort auf zu funktionieren.

Halte das Token geheim. Wer es hat, kann dein Geräteinventar lesen.

Erstelle einen Schlüssel vom Fleet-Dashboard

1. Öffne dein Fleet-Dashboard von der Konsole über Einstellungen > MDM > Fleet öffnen.
2. Klicke auf dein Avatar in der oberen rechten Ecke und wähle Mein Konto.
3. Scrolle nach unten zu API-Token.
4. Klicke auf API-Token abrufen.
5. Kopiere das Token. Es gehört zu deinem Fleet-Benutzerkonto.

Dieses Token hat dieselben Berechtigungen wie dein Fleet-Benutzerkonto. Halte es geheim.

Erstelle einen Schlüssel von der Kommandozeile

Mit dem Fleet CLI:

fleetctl login --email your-email@example.com --url https://<deine-fleet-instanz>
fleetctl get api-token

Oder direkt über die Fleet API:

curl -X POST https://<deine-fleet-instanz>/api/v1/fleet/users/<benutzer-id>/api_token \
  -H "Authorization: Bearer DEIN_BEREITS_VORHANDENES_TOKEN" \
  -H "Content-Type: application/json"

Verwende den Schlüssel

Send das Token im Authorization Header:

curl https://<deine-fleet-instanz>/api/v1/fleet/hosts \
  -H "Authorization: Bearer DEIN_FLEET_API_TOKEN"

Token regenerieren oder widerrufen

• Schlüssel erstellt von Factorial IT: gehe zu Einstellungen > Entwickler > FleetDM API-Schlüssel, öffne das ⋯ Menü in seiner Zeile und klicke auf Widerrufen.
• Token, das mit deinem Fleet-Benutzerkonto verknüpft ist: gehe in Fleet zu Mein Konto und klicke auf API-Token regenerieren. Das alte Token hört sofort auf zu funktionieren.

Fehlerbehebung und FAQ

Fehlerbehebung

• Eine Integration funktioniert nicht mehr. Ihr Schlüssel wurde möglicherweise widerrufen oder das Benutzer-Token regeneriert. Erstelle einen neuen Schlüssel und aktualisiere die Integration.
• Eine Anfrage, um Einstellungen zu ändern oder eine Aktion auszuführen, schlägt fehl. Schlüssel, die von Factorial IT erstellt wurden, sind schreibgeschützt. Verwende ein Token, das mit einem Fleet-Benutzerkonto mit den richtigen Berechtigungen verknüpft ist.
• Du hast das Token verloren. Für einen Schlüssel, der von Factorial IT erstellt wurde, finde es erneut in der Schlüsseltabelle. Für ein Benutzer-Token regeneriere es in Mein Konto in Fleet.

FAQ

1. Verfallen Fleet API-Token?
   Nein. Sie bleiben gültig, bis du sie widerrufst oder regenerierst.
    
2. Was kann ein Schlüssel, der von Factorial IT erstellt wurde, tun?
   Jedes Gerät und dessen Daten lesen. Er kann keine Einstellungen ändern oder Geräteaktionen ausführen.
    
3. Welche Berechtigungen hat ein Token vom Fleet-Dashboard?
   Die gleichen wie dein Fleet-Benutzerkonto.
    
4. Was passiert, wenn ich einen Schlüssel widerrufe?
   Jede Integration, die ihn verwendet, hört sofort auf zu funktionieren.