Introduzione alle API REST di Ootbi

La maggior parte delle persone gestisce i propri Ootbi tramite la sua interfaccia web, e a ragione: è Semplice e veloce. Ma ogni Ootbi dispone anche di una REST API completa, e riceve molta meno attenzione rispetto alla UI.

Secondo Geoff Burke, Senior Technology Advisor, è un’occasione mancata. L’API abilita l’automazione, le integrazioni con gli strumenti che già utilizzi ed è un modo per gestire Ootbi su larga scala che il cliccare tra le schermate non può eguagliare. Ci sono molte altre funzionalità che possono essere eseguite nella UI, come creare utenti, verificare lo stato di salute del cluster, rivedere gli eventi o elencare i bucket; puoi fare anche queste operazioni in modo programmatico.

In questa guida, Geoff Burke spiegherà cos’è la REST API di Ootbi e perché è importante. Poi mostrerà come puoi connetterti a un client API gratuito e open source per Ootbi ed effettuare le tue prime chiamate API.

Il ruolo delle REST API nelle operazioni IT di oggi

Oltre l’interfaccia web

L’interfaccia web è progettata per una persona che gestisce un sistema. Funziona finché il lavoro non cresce. Supponiamo che tu debba creare 15 account utente, controllare ogni mattina lo stato degli aggiornamenti su ogni appliance o eseguire lo stesso report ogni settimana per un auditor. Ora la UI è diventata una serie di clic ripetitivi.

Una REST API consente a un altro programma di svolgere quel lavoro al posto tuo. Il tuo script o la tua applicazione invia una richiesta a Ootbi, che restituisce dati strutturati, e poi decidi tu cosa succede dopo. Questo elimina la necessità di cliccare e copiare valori dalle schermate, riducendo gli errori di inserimento manuale.

Le chiamate non devono necessariamente provenire dall’appliance. Possono arrivare da un laptop, da un server di gestione centralizzato o da qualsiasi sistema della tua rete che possa raggiungere il cluster Ootbi.

Motivi comuni per cui i clienti usano le API

• Efficienza operativa: Automatizza le attività ripetitive che consumano il tempo degli amministratori.

• Test delle funzionalità: Verifica modifiche e nuovi workflow in un cluster di laboratorio prima di distribuirli in produzione.

• Integrazione con gli strumenti esistenti: Alimenta i dati di Ootbi nelle piattaforme di monitoraggio, ticketing e Sicurezza che già utilizzi.

• Reportistica e conformità: Estrai elenchi di utenti, chiavi di accesso e dati degli eventi on demand, in un formato coerente.

• Orchestrazione multi-sistema: Le grandi organizzazioni e i service provider spesso sviluppano un’unica applicazione interna che mette insieme le API di ogni prodotto che utilizzano, hardware e software.

Casi d’uso reali della API di Ootbi

Automatizzare le attività amministrative su larga scala

• Gestione utenti: L’API offre le stesse opzioni di creazione utenti della UI, inclusi gli stessi ruoli. La differenza è che puoi creare utenti in modo programmatico, ad esempio a partire dal tuo processo di gestione delle identità, invece che uno alla volta.

• Controlli di integrità: Le richieste di informazioni su cluster e nodi restituiscono dati dettagliati, inclusi i servizi Ootbi in esecuzione sul cluster e le relative versioni.

• Validazione della configurazione: Un elenco dei bucket mostra impostazioni come se il versioning è abilitato. Il versioning è attivo per impostazione predefinita, ma un controllo pianificato può confermare che nessuno lo abbia disattivato.

• Amministrazione del cluster: Recupera le impostazioni del cluster, le informazioni di licenza e il certificato del cluster senza esportare manualmente nulla dalla UI.

Un esempio spicca: l’API può restituire gli aggiornamenti attualmente disponibili per un cluster o per singoli nodi. Se la tua organizzazione utilizza un sistema centralizzato di tracciamento degli aggiornamenti, puoi collegare Ootbi a tale sistema. Riporterà la versione corrente e gli eventuali aggiornamenti disponibili insieme a tutto il resto del tuo ambiente. Questo conta più che mai: oggi gli attaccanti trasformano le vulnerabilità appena divulgate in exploit funzionanti più rapidamente che mai, quindi qualsiasi sistema non patchato è un bersaglio.

Integrazioni di monitoraggio e alerting

L’endpoint degli eventi di Ootbi restituisce ogni evento con il suo ID, la sorgente, la severità e i dettagli, tutto come JSON strutturato. Questo rende i dati facili da inviare a piattaforme come:

• Splunk o un altro SIEM, per la visibilità Sicurezza

• PagerDuty, per l’invio di alert su eventi ad alta severità

• ServiceNow, per creare ticket automaticamente

• Grafana, per le dashboard

Nel loro insieme, questi elementi rendono Ootbi parte di una vista “single pane of glass” della tua infrastruttura, invece di una console separata da controllare.

Reportistica di conformità e audit

• Raccolta dei dati di audit: Estrai elenchi degli utenti di gestione e dei loro ruoli, delle sessioni attive e delle chiavi di accesso, incluso quando ciascuna chiave è stata emessa l’ultima volta.

• Generazione di report di conformità: Esegui le stesse chiamate secondo una pianificazione e produci report coerenti senza screenshot o esportazioni manuali.

• Supporto di ambienti regolamentati: Quando un auditor chiede chi ha accesso al tuo Backup Storage e a quale livello, puoi rispondere con dati estratti direttamente dal sistema.

La visibilità sulle chiavi di accesso è importante anche in ambienti piccoli. In un laboratorio molto attivo in cui molte persone creano chiavi, una singola chiamata API mostra ogni chiave e quando è stata creata, così la pulizia si basa sui fatti invece che su supposizioni.

Gestione MSP e multi-tenant

I service provider gestiscono molti prodotti su molti clienti. Un approccio comune è sviluppare un’unica applicazione interna sopra l’API di ogni vendor. Da quell’applicazione, il team può creare account, effettuare il provisioning dei bucket Storage e raccogliere informazioni senza accedere separatamente a ciascun sistema.

• Gestione di più deployment dei clienti: Interroga il Ootbi di ciascun cliente da un unico strumento centrale.

• Creazione di portali di gestione personalizzati: Crea viste su misura, ad esempio un portale per amministratori junior che espone solo determinate funzioni.

• Riduzione di Sovraccarico operativo: Standardizza provisioning e reportistica su ogni deployment.

Esplorare la API di Ootbi con Swagger

Accedere a Swagger

Ogni Ootbi include documentazione API integrata basata su Swagger, uno strumento che presenta un’API come una pagina web interattiva. Non c’è nulla di nascosto. Chiunque disponga di un Ootbi può aprirla aggiungendo /swagger/index.html all’indirizzo del cluster:

https://<your-Ootbi-cluster-address>:8443/swagger/index.html

Pagina di destinazione di Swagger

Swagger elenca ogni endpoint disponibile, raggruppato per area, inclusi utenti, cluster, nodi, bucket, chiavi di accesso, eventi e aggiornamenti. Ognuno è contrassegnato con il relativo metodo HTTP:

• GET recupera informazioni, come un elenco di utenti.

• POST invia informazioni, come i dettagli di un nuovo utente.

Per ogni endpoint, Swagger mostra la richiesta prevista e la risposta restituita. Puoi anche fare clic su Try it out per eseguire una richiesta direttamente dal browser.

Swagger fornisce anche la definizione completa dell’API come un unico file JSON scaricabile. Gli sviluppatori possono cercarlo, importarlo in altri strumenti o darlo a un assistente AI per esplorare cosa potrebbero realizzare.

Esempio di link JSON di Swagger: https://192.168.0.172:8443/swagger/v1/swagger.json

Sostituisci l’ID del cluster di esempio con l’indirizzo IP del tuo cluster.

 

Sfide dei test API basati su browser

Swagger è ottimo per esplorare, ma meno comodo per il lavoro reale:

• Attrito nell’autenticazione: Prima di eseguire una richiesta, chiami l’endpoint di login con nome utente e password, copi il bearer token che restituisce e lo incolli nella finestra di dialogo Autorizza di Swagger.

• Limitazioni nella gestione delle sessioni: Per motivi Sicurezza, i token Ootbi hanno vita breve. Scadono rapidamente e devi ripetere la procedura, spesso nel mezzo di ciò che stai facendo.

• Mancanza di flussi di lavoro riutilizzabili: Swagger non salva i tuoi valori o le tue richieste. Ogni sessione riparte da zero.

Ecco perché usiamo un client API Dedicato.

Lavorare con l’API Ootbi in un client API

Puoi usare qualsiasi client API per lavorare con l’API Ootbi. I passaggi sotto sono istruzioni generali per collegare un client API a Ootbi. Tieni presente che i nomi dei menu e le opzioni possono variare in base al client, quindi consulta la documentazione del tuo client per i dettagli.

Cosa ti offre un client API quando testi Ootbi

• Impostazioni di autenticazione salvate: Configura il login una sola volta e riutilizzalo per ogni richiesta.

• Rinnovo automatico del token: Un breve script può recuperare un nuovo token e rinnovarlo automaticamente, così la breve durata dei token non interrompe il tuo lavoro.

• Raccolte e ambienti: Importa l’intera API Ootbi come raccolta ricercabile e usa gli ambienti per passare dai cluster di laboratorio a quelli di produzione.

• Test più rapidi: Modifica un valore, fai clic su invia e vedi il risultato. Niente più copia dei token tra schede.

Client API comuni

Ecco tre client API ampiamente utilizzati, elencati in ordine alfabetico. Sono esempi, non raccomandazioni. Scegli quello che meglio si adatta alle esigenze del tuo team e alle policy Sicurezza.

Bruno

Bruno è un client API leggero, local-first, per creare e testare richieste API. È gratuito e open source. Le raccolte vengono salvate come file di testo semplice sulla tua macchina, così puoi tenere le richieste sotto controllo versione in Git e condividerle tramite i repository esistenti. Bruno importa file OpenAPI (Swagger) e supporta ambienti, variabili segrete e scripting.

Insomnia

Sviluppato da Kong, Insomnia è un client API multipiattaforma noto per la sua interfaccia pulita e intuitiva. Come Bruno, è gratuito e open source. Gestisce molti protocolli, inclusi REST, GraphQL, gRPC e WebSocket, e puoi archiviare i progetti in locale, sincronizzarli con Git o conservarli nel cloud. Insomnia importa anche file OpenAPI (Swagger) e aggiunge plugin per flussi di lavoro personalizzati.

Postman

Essendo una delle piattaforme API più adottate, Postman offre ai team un unico posto per progettare, testare, documentare e monitorare le API. È gratuito da scaricare per macOS, Windows e Linux e funziona anche in un browser web. Postman supporta importazioni OpenAPI (Swagger), ambienti, script pre-request e di test, ed esecuzioni automatizzate delle raccolte. I suoi spazi di lavoro condivisi rendono semplice la collaborazione del team.

Collegare il tuo client API a Ootbi

Passo 1: Installa un client API

Ogni client avrà il proprio processo di autenticazione, che dovrebbe essere in grado di importare il file JSON di Swagger.

Passo 2: Testa la connettività

Esegui una richiesta Semplice, come quella che restituisce le sessioni attive. Un codice di stato 200 significa che Ootbi accetta il tuo token e la connessione funziona. La risposta elenca le sessioni correnti sul cluster, inclusa la tua.

Eseguire le tue prime chiamate API Ootbi

Esempio 1: Recuperare informazioni sul cluster

Invia la richiesta Ottieni informazioni generali sui cluster. La risposta è dettagliata: oltre ai dettagli del cluster e dei nodi, elenca i servizi Ootbi in esecuzione sul cluster e le relative versioni, informazioni che non troverai in un unico punto nell’interfaccia utente.

Esempio 2: Verificare la disponibilità di aggiornamenti

Invia la richiesta aggiornamenti attualmente disponibili usando l’Id del tuo cluster. La risposta mostra la tua versione corrente e qualsiasi versione disponibile.

In pratica, uno strumento centrale di monitoraggio degli aggiornamenti eseguirebbe questa chiamata a intervalli pianificati, salverebbe la versione corrente e segnalerebbe quando un aggiornamento diventa disponibile. Esiste anche una versione per nodo di questa richiesta, che aiuta a individuare un nodo rimasto indietro in un cluster multi-nodo.

Esempio 3: Estrarre dati di utenti ed eventi

Per un esempio orientato alla conformità, prova due richieste:

• Restituisce l’elenco degli utenti di gestione: Restituisce ogni utente di gestione con ruolo e livello di accesso. Crea nell’interfaccia utente un nuovo utente in sola lettura (ruolo Monitoring), esegui di nuovo la richiesta e il nuovo utente appare immediatamente: un modo rapido per vedere che API e UI mostrano gli stessi dati.

• Eventi: Restituisce gli eventi con ID, origine, severità e dettagli. Sono le stesse informazioni che otterresti da syslog, ma come JSON strutturato che non richiede parsing. È pronto per essere inviato a un SIEM o a uno strumento di reporting.

Andare oltre: creare integrazioni

Esportare i dati Ootbi verso un SIEM

Il tuo team Sicurezza vuole gli eventi dell’infrastruttura Backup insieme a tutto il resto. Un flusso di lavoro Semplice:

1. Uno script sul tuo server collector autentica Ootbi e richiede gli eventi a intervalli pianificati.
2. Conserva solo i nuovi eventi dall’ultima esecuzione.
3. Li inoltra al tuo SIEM, dove possono essere correlati, ricercati e usati per generare alert.

Creare report automatizzati

Lo stesso approccio abilita il reporting pianificato. Estrai utenti, chiavi di accesso, bucket (incluso lo stato del versioning) e informazioni di licenza ogni settimana, e trasforma i risultati in un report coerente o in una dashboard che il tuo team controlla ogni giorno.

Integrare con i flussi di lavoro IT esistenti

• Sistemi di ticketing: Apri automaticamente un ticket quando compare un evento ad alta severità o quando diventa disponibile un aggiornamento.

• Piattaforme di monitoraggio: Aggiungi i dati di stato e capacità di Ootbi alle dashboard che il tuo team operativo usa già.

• Strumenti interni: Integra Ootbi nel tuo portale di provisioning, ad esempio per creare utenti o bucket come parte dell’onboarding di un nuovo team o cliente.

Con gli assistenti di coding basati su IA, creare queste piccole integrazioni è più facile che mai, anche se non ti consideri uno sviluppatore.

Conclusione

La REST API Ootbi estende Ootbi ben oltre l’interfaccia web. È integrata in ogni appliance, documentata tramite Swagger e disponibile per chiunque possieda un Ootbi. Assicurati di scegliere un client API facile da esplorare, testare e, alla fine, da usare per automatizzare flussi di lavoro guidati dalle API.

Che tu sia un amministratore IT, uno sviluppatore, un MSP o un team Sicurezza, l’API Ootbi può aiutarti a snellire le operazioni, migliorare la visibilità e integrare la tua infrastruttura Backup nei processi enterprise esistenti. Apri Swagger sul tuo cluster e guarda cosa puoi costruire.