Primeros pasos con las API REST de Ootbi

La mayoría de las personas administran su(s) Ootbi a través de su interfaz web, y con razón: es Simple y rápida. Pero cada Ootbi también tiene una API REST completa, y recibe mucha menos atención que la IU.

Según Geoff Burke, Asesor Sénior de Tecnología, eso es una oportunidad perdida. La API habilita la automatización, las integraciones con las herramientas que ya usas y es una forma de administrar Ootbi a escala que hacer clic por pantallas no puede igualar. Hay muchas otras funcionalidades que se pueden realizar en la IU, como crear usuarios, comprobar el estado del clúster, revisar eventos o listar buckets; también puedes hacer esto de forma programática.

En esta guía, Geoff Burke explicará qué es la API REST de Ootbi y por qué es importante. Luego demostrará cómo puedes conectarte a un cliente de API gratuito y de código abierto para Ootbi y realizar tus primeras llamadas a la API.

El papel de las API REST en las operaciones de TI actuales

Más allá de la interfaz web

La interfaz web está diseñada para una persona que administra un sistema. Eso funciona hasta que el trabajo crece. Supón que necesitas crear 15 cuentas de usuario, comprobar cada mañana el estado de actualización de cada appliance o ejecutar el mismo informe cada semana para un auditor. Ahora la IU se ha convertido en una serie de clics repetitivos.

Una API REST permite que otro programa haga ese trabajo por ti. Tu script o aplicación envía una solicitud a Ootbi, que devuelve datos estructurados, y luego tú decides qué sucede a continuación. Esto elimina la necesidad de hacer clic y copiar valores desde pantallas, reduciendo los errores de entrada manual.

Las llamadas tampoco tienen que provenir del appliance. Pueden provenir de un portátil, de un servidor central de administración o de cualquier sistema de tu red que pueda alcanzar el clúster Ootbi.

Motivos comunes por los que los clientes usan API

• Eficiencia operativa: Automatiza las tareas repetitivas que consumen el tiempo de los administradores.

• Pruebas de funcionalidad: Comprueba cambios y nuevos flujos de trabajo en un clúster de laboratorio antes de desplegarlos en producción.

• Integración con herramientas existentes: Alimenta los datos de Ootbi en las plataformas de monitorización, ticketing y Seguridad que ya utilizas.

• Informes y cumplimiento: Extrae listas de usuarios, claves de acceso y datos de eventos bajo demanda, en un formato coherente.

• Orquestación multisistema: Las grandes organizaciones y los proveedores de servicios a menudo crean una aplicación interna que reúne las API de cada producto que ejecutan, hardware y software.

Casos de uso reales de la API de Ootbi

Automatización de tareas administrativas a escala

• Gestión de usuarios: La API tiene las mismas opciones de creación de usuarios que la IU, incluidos los mismos roles. La diferencia es que puedes crear usuarios de forma programática, por ejemplo desde tu proceso de gestión de identidades, en lugar de uno por uno.

• Comprobaciones de estado: Las solicitudes de información del clúster y de los nodos devuelven datos detallados, incluidos los servicios de Ootbi que se ejecutan en el clúster y sus versiones.

• Validación de configuración: Un listado de buckets muestra ajustes como si el versionado está habilitado. El versionado está activado de forma predeterminada, pero una comprobación programada puede confirmar que nadie lo ha desactivado.

• Administración del clúster: Recupera la configuración del clúster, la información de licencia y el certificado del clúster sin exportar manualmente nada desde la IU.

Un ejemplo destaca: la API puede devolver las actualizaciones disponibles actualmente para un clúster o para nodos individuales. Si tu organización ejecuta un sistema central de seguimiento de actualizaciones, puedes conectar Ootbi a él. Informará su versión actual y cualquier actualización disponible junto con todo lo demás en tu entorno. Eso importa más que nunca: los atacantes ahora convierten vulnerabilidades recién divulgadas en exploits funcionales más rápido que nunca, por lo que cualquier sistema sin parches es un objetivo.

Integraciones de monitorización y alertas

El endpoint de eventos de Ootbi devuelve cada evento con su ID, origen, severidad y detalles, todo como JSON estructurado. Eso hace que los datos sean fáciles de enviar a plataformas como:

• Splunk u otro SIEM, para visibilidad de Seguridad

• PagerDuty, para alertar sobre eventos de alta severidad

• ServiceNow, para crear tickets automáticamente

• Grafana, para paneles

En conjunto, esto hace que Ootbi forme parte de una vista de panel único de tu infraestructura en lugar de una consola separada que revisar.

Informes de cumplimiento y auditoría

• Recopilación de datos de auditoría: Extrae listas de usuarios de administración y sus roles, sesiones activas y claves de acceso, incluido cuándo se emitió por última vez cada clave.

• Generación de informes de cumplimiento: Ejecuta las mismas llamadas según un calendario y produce informes coherentes sin capturas de pantalla ni exportaciones manuales.

• Soporte de entornos regulados: Cuando un auditor pregunta quién tiene acceso a tu Almacenamiento de backup y a qué nivel, puedes responder con datos extraídos directamente del sistema.

La visibilidad de las claves de acceso importa incluso en entornos pequeños. En un laboratorio con mucha actividad donde muchas personas crean claves, una sola llamada a la API muestra cada clave y cuándo se creó, de modo que la limpieza se basa en hechos en lugar de suposiciones.

Gestión MSP y multiinquilino

Los proveedores de servicios administran muchos productos en muchos clientes. Un enfoque común es crear una aplicación interna sobre la API de cada proveedor. Desde esa aplicación, el equipo puede crear cuentas, aprovisionar buckets de almacenamiento y recopilar información sin iniciar sesión en cada sistema por separado.

• Gestión de múltiples despliegues de clientes: Consulta el Ootbi de cada cliente desde una herramienta central.

• Creación de portales de gestión personalizados: Crea vistas a medida, por ejemplo un portal para administradores junior que exponga solo ciertas funciones.

• Reducción de Sobrecarga operativa: Estandariza el aprovisionamiento y los informes en cada despliegue.

Exploración de la API de Ootbi con Swagger

Acceso a Swagger

Cada Ootbi incluye documentación de API integrada impulsada por Swagger, una herramienta que presenta una API como una página web interactiva. No hay nada oculto al respecto. Cualquiera que tenga un Ootbi puede abrirla añadiendo /swagger/index.html a la dirección del clúster:

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

Página de inicio de Swagger

Swagger enumera cada endpoint disponible, agrupado por área, incluidos usuarios, clústeres, nodos, buckets, claves de acceso, eventos y actualizaciones. Cada uno está marcado con su método HTTP:

• GET recupera información, como una lista de usuarios.

• POST envía información, como los detalles de un nuevo usuario.

Para cada endpoint, Swagger muestra la solicitud que espera y la respuesta que devuelve. También puedes hacer clic en Try it out para ejecutar una solicitud directamente desde el navegador.

Swagger también proporciona la definición completa de la API como un único archivo JSON descargable. Los desarrolladores pueden buscar en él, importarlo en otras herramientas o dárselo a un asistente de IA para explorar qué podrían construir.

Enlace de ejemplo de Swagger Json: https://192.168.0.172:8443/swagger/v1/swagger.json

Sustituye el ID de clúster de ejemplo por la dirección IP de tu propio clúster.

 

Desafíos de las pruebas de API basadas en navegador

Swagger es excelente para explorar, pero menos conveniente para el trabajo real:

• Fricción de autenticación: Antes de ejecutar una solicitud, llamas al endpoint de inicio de sesión con un nombre de usuario y contraseña, copias el token bearer que devuelve y lo pegas en el cuadro de diálogo Authorize de Swagger.

• Limitaciones de gestión de sesión: Por motivos de Seguridad, los tokens de Ootbi tienen una vida corta. Caducan rápidamente y debes repetir el proceso, a menudo en mitad de lo que estás haciendo.

• Falta de flujos de trabajo reutilizables: Swagger no guarda tus valores ni tus solicitudes. Cada sesión empieza desde cero.

Por eso usamos un cliente de API Dedicado.

Trabajar con la API Ootbi en un cliente de API

Puedes usar cualquier cliente de API para trabajar con la API Ootbi. Los pasos siguientes son instrucciones generales para conectar un cliente de API a Ootbi. Ten en cuenta que los nombres de menús y las opciones pueden variar según el cliente, así que consulta la documentación de tu cliente para obtener más detalles.

Lo que te aporta un cliente de API al probar Ootbi

• Configuración de autenticación guardada: Configura el inicio de sesión una vez y reutilízalo para cada solicitud.

• Renovación automática de tokens: Un script corto puede obtener un token nuevo y renovarlo automáticamente, de modo que las vidas útiles cortas de los tokens no interrumpan tu trabajo.

• Colecciones y entornos: Importa toda la API Ootbi como una colección con búsqueda y usa entornos para alternar entre clústeres de laboratorio y de producción.

• Pruebas más rápidas: Cambia un valor, haz clic en enviar y mira el resultado. Se acabó copiar tokens entre pestañas.

Clientes de API comunes

Aquí tienes tres clientes de API ampliamente utilizados, listados en orden alfabético. Son ejemplos, no recomendaciones. Elige el que mejor se ajuste a las necesidades de tu equipo y a las políticas de Seguridad.

Bruno

Bruno es un cliente de API ligero, con enfoque local primero, para crear y probar solicitudes de API. Es gratuito y de código abierto. Las colecciones se guardan como archivos de texto sin formato en tu propia máquina, por lo que puedes mantener las solicitudes bajo control de versiones en Git y compartirlas a través de tus repositorios existentes. Bruno importa archivos OpenAPI (Swagger) y admite entornos, variables secretas y scripting.

Insomnia

Desarrollado por Kong, Insomnia es un cliente de API multiplataforma conocido por su interfaz limpia e intuitiva. Al igual que Bruno, es gratuito y de código abierto. Maneja muchos protocolos, incluidos REST, GraphQL, gRPC y WebSockets, y puedes almacenar proyectos localmente, sincronizarlos con Git o almacenarlos en la nube. Insomnia también importa archivos OpenAPI (Swagger) y añade plugins para flujos de trabajo personalizados.

Postman

Como una de las plataformas de API más adoptadas, Postman ofrece a los equipos un único lugar para diseñar, probar, documentar y supervisar APIs. Es gratuito para descargar en macOS, Windows y Linux, y también se ejecuta en un navegador web. Postman admite importaciones de OpenAPI (Swagger), entornos, scripts previos a la solicitud y de prueba, y ejecuciones automatizadas de colecciones. Sus espacios de trabajo compartidos facilitan la colaboración del equipo.

Conectar tu cliente de API a Ootbi

Paso 1: Instalar un cliente de API

Cada cliente tendrá su propio proceso de autenticación, que debería poder importar el archivo JSON de Swagger.

Paso 2: Probar la conectividad

Ejecuta una solicitud Simple, como la que devuelve las sesiones activas. Un código de estado 200 significa que Ootbi acepta tu token y la conexión funciona. La respuesta enumera las sesiones actuales en el clúster, incluida la tuya.

Ejecutar tus primeras llamadas a la API Ootbi

Ejemplo 1: Recuperar información del clúster

Envía la solicitud Obtener información general sobre clústeres. La respuesta es detallada: junto con los detalles del clúster y de los nodos, enumera los servicios de Ootbi que se ejecutan en el clúster y sus versiones, información que no encontrarás reunida en un solo lugar en la IU.

Ejemplo 2: Comprobar actualizaciones disponibles

Envía la solicitud actualizaciones disponibles actualmente usando el Id de tu clúster. La respuesta muestra tu versión actual y cualquier versión disponible.

En la práctica, una herramienta central de supervisión de actualizaciones ejecutaría esta llamada según una programación, guardaría la versión actual y marcaría cuando una actualización pase a estar disponible. También existe una versión por nodo de esta solicitud, que ayuda a detectar un nodo que se ha quedado atrás en un clúster multinodo.

Ejemplo 3: Extraer datos de usuarios y eventos

Para un ejemplo centrado en el cumplimiento, prueba dos solicitudes:

• Devuelve la lista de usuarios de administración: Devuelve todos los usuarios de administración con su rol y nivel de acceso. Crea un nuevo usuario de solo lectura (rol de Supervisión) en la IU, ejecuta la solicitud de nuevo y el nuevo usuario aparece de inmediato, una forma rápida de ver que la API y la IU muestran los mismos datos.

• Eventos: Devuelve eventos con su ID, origen, gravedad y detalles. Es la misma información que obtendrías de syslog, pero como JSON estructurado que no requiere análisis. Está listo para incorporarse a un SIEM o a una herramienta de informes.

Ir más allá: crear integraciones

Exportar datos de Ootbi a un SIEM

Tu equipo de Seguridad quiere eventos de infraestructura de Backup junto con todo lo demás. Un flujo de trabajo Simple:

1. Un script en tu servidor colector autentica en Ootbi y solicita eventos según una programación.
2. Conserva solo los eventos nuevos desde la última ejecución.
3. Los reenvía a tu SIEM, donde pueden correlacionarse, buscarse y generar alertas.

Crear informes automatizados

El mismo enfoque impulsa los informes programados. Extrae usuarios, claves de acceso, buckets (incluido el estado de versionado) e información de licencias semanalmente, y convierte los resultados en un informe coherente o en un panel que tu equipo consulta cada día.

Integrar con flujos de trabajo de TI existentes

• Sistemas de tickets: Abre un ticket automáticamente cuando aparezca un evento de alta gravedad o cuando haya una actualización disponible.

• Plataformas de monitorización: Añade los datos de estado y capacidad de Ootbi a los paneles que tu equipo de operaciones ya utiliza.

• Herramientas internas: Integra Ootbi en tu portal de aprovisionamiento, por ejemplo para crear usuarios o buckets como parte de la incorporación de un nuevo equipo o cliente.

Con asistentes de programación con IA, crear estas pequeñas integraciones es más fácil que nunca, incluso si no te consideras desarrollador.

Conclusión

La API REST de Ootbi amplía Ootbi mucho más allá de la interfaz web. Está integrada en cada appliance, documentada mediante Swagger y disponible para cualquiera que posea un Ootbi. Asegúrate de elegir un cliente de API que sea fácil de explorar, probar y, con el tiempo, automatizar flujos de trabajo impulsados por API.

Tanto si eres un administrador de TI, un desarrollador, un MSP o un equipo de Seguridad, la API Ootbi puede ayudarte a optimizar las operaciones, mejorar la visibilidad e integrar tu infraestructura de Backup en tus procesos empresariales existentes. Abre Swagger en tu clúster y mira lo que puedes crear.