Una chiave API di Fleet ti consente di comunicare direttamente con la tua istanza di Fleet. Usala per eseguire script, estrarre dati sui dispositivi o connettere Fleet ad altri strumenti.

Funzionalità

Panoramica

Le chiavi API di Fleet (FleetDM) autenticano le richieste inviate direttamente alla tua istanza di Fleet. Puoi crearle in tre modi:

• Da Factorial IT, come chiave di sola lettura.
• Dal dashboard di Fleet, come token legato al tuo account utente di Fleet.
• Dal terminale, con il Fleet CLI o l'API di Fleet.

I token API di Fleet non scadono mai da soli.

Come usare: crea una chiave da Factorial IT

1. Vai su Impostazioni > Sviluppatori e scorri verso il basso fino alla sezione Chiave API di FleetDM.
2. Digita un Nome chiave, ad esempio lo strumento che utilizzerà la chiave.
3. Clicca su Genera chiave.
4. Copia il token mostrato nella finestra Chiave API di FleetDM creata. Rimane disponibile successivamente nella tabella delle chiavi.

Le chiavi create da Factorial IT sono di sola lettura. Possono vedere ogni dispositivo e i suoi dati, ma non possono modificare impostazioni o eseguire azioni sui dispositivi. Sono adatte per integrazioni esterne che devono solo leggere la tua istanza di Fleet.

Per revocarne una, apri il menu ⋯ sulla sua riga nella tabella Chiave API di FleetDM e clicca su Revoca. Qualsiasi integrazione che la utilizza smette di funzionare immediatamente.

Mantieni segreto il token. Chiunque lo possieda può leggere il tuo inventario di dispositivi.

Crea una chiave dal dashboard di Fleet

1. Apri il tuo dashboard di Fleet dalla console tramite Impostazioni > MDM > Apri Fleet.
2. Clicca sulla tua avatar nell'angolo in alto a destra e seleziona Il mio account.
3. Scorri verso il basso fino a Token API.
4. Clicca su Ottieni token API.
5. Copia il token. Appartiene al tuo account utente di Fleet.

Questo token ha le stesse autorizzazioni del tuo account utente di Fleet. Mantienilo segreto.

Crea una chiave dalla riga di comando

Con il Fleet CLI:

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

O direttamente tramite l'API di Fleet:

curl -X POST https://<your-fleet-instance>/api/v1/fleet/users/<user-id>/api_token \
  -H "Authorization: Bearer YOUR_EXISTING_TOKEN" \
  -H "Content-Type: application/json"

Usa la chiave

Invia il token nell'intestazione Authorization:

curl https://<your-fleet-instance>/api/v1/fleet/hosts \
  -H "Authorization: Bearer YOUR_FLEET_API_TOKEN"

Rigenera o revoca un token

• Chiave creata da Factorial IT: vai su Impostazioni > Sviluppatori > Chiave API di FleetDM, apri il menu ⋯ sulla sua riga e clicca su Revoca.
• Token legato al tuo account utente di Fleet: in Fleet, vai su Il mio account e clicca su Rigenera token API. Il vecchio token smette di funzionare immediatamente.

Risoluzione dei problemi e FAQ

Risoluzione dei problemi

• Un'integrazione ha smesso di funzionare. La sua chiave potrebbe essere stata revocata, o il token utente rigenerato. Crea una nuova chiave e aggiorna l'integrazione.
• Una richiesta di modifica delle impostazioni o di esecuzione di un'azione fallisce. Le chiavi create da Factorial IT sono di sola lettura. Usa un token legato a un account utente di Fleet con le autorizzazioni corrette.
• Hai perso il token. Per una chiave creata da Factorial IT, trovala di nuovo nella tabella delle chiavi. Per un token utente, rigeneralo in Il mio account in Fleet.

FAQ

1. I token API di Fleet scadono?
   No. Rimangono validi fino a quando non li revoci o rigeneri.
    
2. Cosa può fare una chiave creata da Factorial IT?
   Leggere ogni dispositivo e i suoi dati. Non può modificare impostazioni o eseguire azioni sui dispositivi.
    
3. Quali autorizzazioni ha un token dal dashboard di Fleet?
   Le stesse del tuo account utente di Fleet.
    
4. Cosa succede quando revoco una chiave?
   Tutte le integrazioni che la utilizzano smettono di funzionare immediatamente.