Primeiros passos com APIs REST do Ootbi

A maioria das pessoas gerencia seus/suas Ootbi(s) pela interface web, e por um bom motivo: ela é Simples e rápida. Mas todo(a) Ootbi também tem uma API REST completa, e ela recebe bem menos atenção do que a UI.

Segundo Geoff Burke, Consultor Sênior de Tecnologia, isso é uma oportunidade perdida. A API habilita automação, integrações com as ferramentas que você já usa e é uma forma de gerenciar Ootbi em escala que clicar por telas não consegue igualar. Há muitas outras funcionalidades que podem ser executadas na UI, como criar usuários, verificar a integridade do cluster, revisar eventos ou listar buckets; você também pode fazer isso de forma programática.

Neste guia, Geoff Burke explicará o que é a API REST do(a) Ootbi e por que ela é importante. Em seguida, ele demonstrará como você pode se conectar a um cliente de API gratuito e de código aberto ao(à) Ootbi e fazer suas primeiras chamadas de API.

O papel das APIs REST nas operações de TI atuais

Além da interface web

A interface web foi criada para uma pessoa gerenciando um sistema. Isso funciona até o trabalho crescer. Suponha que você precise criar 15 contas de usuário, verificar o status de atualização em cada appliance todas as manhãs ou executar o mesmo relatório toda semana para um auditor. Agora a UI virou uma série de cliques repetitivos.

Uma API REST permite que outro programa faça esse trabalho por você. Seu script ou aplicativo envia uma solicitação ao(à) Ootbi, que retorna dados estruturados, e então você decide o que acontece em seguida. Isso elimina a necessidade de clicar e copiar valores das telas, reduzindo erros de entrada manual.

As chamadas também não precisam vir do appliance. Elas podem vir de um laptop, de um servidor central de gerenciamento ou de qualquer sistema na sua rede que consiga alcançar o cluster Ootbi.

Motivos comuns pelos quais clientes usam APIs

• Eficiência operacional: Automatize as tarefas repetitivas que consomem o tempo dos administradores.

• Testes de funcionalidade: Verifique mudanças e novos fluxos de trabalho em um cluster de laboratório antes de colocá-los em produção.

• Integração com ferramentas existentes: Alimente os dados do(a) Ootbi nas plataformas de monitoramento, abertura de chamados e segurança que você já usa.

• Relatórios e conformidade: Extraia listas de usuários, chaves de acesso e dados de eventos sob demanda, em um formato consistente.

• Orquestração de múltiplos sistemas: Grandes organizações e provedores de serviços frequentemente criam um aplicativo interno que reúne as APIs de todos os produtos que operam, hardware e software.

Casos de uso reais da API do(a) Ootbi

Automatizando tarefas administrativas em escala

• Gerenciamento de usuários: A API tem as mesmas opções de criação de usuários que a UI, incluindo as mesmas funções. A diferença é que você pode criar usuários de forma programática, por exemplo a partir do seu processo de gerenciamento de identidades, em vez de um por vez.

• Verificações de integridade: Solicitações de informações do cluster e dos nós retornam dados detalhados, incluindo os serviços do(a) Ootbi em execução no cluster e suas versões.

• Validação de configuração: Uma listagem de buckets mostra configurações como se o versionamento está habilitado. O versionamento vem ativado por padrão, mas uma verificação agendada pode confirmar que ninguém o desativou.

• Administração do cluster: Recupere configurações do cluster, informações de licença e o certificado do cluster sem exportar manualmente nada pela UI.

Um exemplo se destaca: a API pode retornar atualizações disponíveis no momento para um cluster ou para nós individuais. Se sua organização opera um sistema central de acompanhamento de atualizações, você pode conectar o(a) Ootbi a ele. Ele informará sua versão atual e quaisquer atualizações disponíveis junto com todo o restante no seu ambiente. Isso importa mais do que nunca: atacantes agora transformam vulnerabilidades recém-divulgadas em exploits funcionais mais rápido do que nunca, então qualquer sistema sem patch é um alvo.

Integrações de monitoramento e alertas

O endpoint de eventos do(a) Ootbi retorna cada evento com seu ID, origem, severidade e detalhes, tudo como JSON estruturado. Isso torna os dados fáceis de enviar para plataformas como:

• Splunk ou outro SIEM, para visibilidade de segurança

• PagerDuty, para alertas de eventos de alta severidade

• ServiceNow, para criar tickets automaticamente

• Grafana, para dashboards

Juntas, essas integrações fazem do(a) Ootbi parte de uma visão de painel único da sua infraestrutura, em vez de um console separado para verificar.

Relatórios de conformidade e auditoria

• Coleta de dados de auditoria: Extraia listas de usuários de gerenciamento e suas funções, sessões ativas e chaves de acesso, incluindo quando cada chave foi emitida pela última vez.

• Geração de relatórios de conformidade: Execute as mesmas chamadas em uma agenda e produza relatórios consistentes sem capturas de tela ou exportações manuais.

• Suporte a ambientes regulados: Quando um auditor pergunta quem tem acesso ao seu armazenamento Backup e em que nível, você pode responder com dados extraídos diretamente do sistema.

A visibilidade das chaves de acesso importa até em ambientes pequenos. Em um laboratório movimentado onde muitas pessoas criam chaves, uma única chamada de API mostra cada chave e quando ela foi criada, então a limpeza se baseia em fatos em vez de suposições.

MSP e gerenciamento multi-tenant

Provedores de serviços gerenciam muitos produtos em muitos clientes. Uma abordagem comum é criar um aplicativo interno sobre a API de cada fornecedor. A partir desse aplicativo, a equipe pode criar contas, provisionar buckets de armazenamento e coletar informações sem fazer login em cada sistema separadamente.

• Gerenciamento de múltiplas implantações de clientes: Consulte o(a) Ootbi de cada cliente a partir de uma ferramenta central.

• Criação de portais de gerenciamento personalizados: Crie visões sob medida, por exemplo um portal para administradores juniores que exponha apenas determinadas funções.

• Redução de overhead operacional: Padronize o provisionamento e os relatórios em todas as implantações.

Explorando a API do(a) Ootbi com o Swagger

Acessando o Swagger

Todo(a) Ootbi inclui documentação de API integrada, baseada em Swagger, uma ferramenta que apresenta uma API como uma página web interativa. Não há nada oculto nisso. Qualquer pessoa com um(a) Ootbi pode abri-la adicionando /swagger/index.html ao endereço do cluster:

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

Página inicial do Swagger

O Swagger lista todos os endpoints disponíveis, agrupados por área, incluindo usuários, clusters, nós, buckets, chaves de acesso, eventos e atualizações. Cada um é marcado com seu método HTTP:

• GET recupera informações, como uma lista de usuários.

• POST envia informações, como os detalhes de um novo usuário.

Para cada endpoint, o Swagger mostra a requisição que ele espera e a resposta que ele retorna. Você também pode clicar em Try it out para executar uma requisição diretamente do navegador.

O Swagger também fornece a definição completa da API como um único arquivo JSON para download. Desenvolvedores podem pesquisá-lo, importá-lo para outras ferramentas ou entregá-lo a um assistente de IA para explorar o que poderiam construir.

Exemplo de link JSON do Swagger: https://192.168.0.172:8443/swagger/v1/swagger.json

Substitua o ID de cluster do exemplo pelo endereço IP do seu próprio cluster.

 

Desafios dos testes de API baseados em navegador

O Swagger é ótimo para navegação, mas menos conveniente para trabalho real:

• Atrito na autenticação: Antes de executar uma requisição, você chama o endpoint de login com um nome de usuário e senha, copia o token bearer que ele retorna e cola na caixa de diálogo Authorize do Swagger.

• Limitações no gerenciamento de sessão: Por motivos de segurança, os tokens do(a) Ootbi têm vida curta. Eles expiram rapidamente, e você precisa repetir o processo, muitas vezes no meio do que está fazendo.

• Falta de fluxos de trabalho reutilizáveis: O Swagger não salva seus valores nem suas requisições. Cada sessão começa do zero.

É por isso que usamos um cliente de API Dedicado.

Trabalhando com a API do(a) Ootbi em um cliente de API

Você pode usar qualquer cliente de API para trabalhar com a API do(a) Ootbi. As etapas abaixo são instruções gerais para conectar um cliente de API ao(à) Ootbi. Observe que nomes de menus e opções podem variar conforme o cliente, então consulte a documentação do seu cliente para obter detalhes.

O que um cliente de API oferece ao testar Ootbi

• Configurações de autenticação salvas: Configure o login uma vez e reutilize-o em todas as solicitações.

• Renovação automática de token: Um script curto pode obter um novo token e renová-lo automaticamente, para que tempos de vida curtos de token não interrompam seu trabalho.

• Coleções e ambientes: Importe toda a API Ootbi como uma coleção pesquisável e use ambientes para alternar entre clusters de laboratório e de produção.

• Testes mais rápidos: Altere um valor, clique em enviar e veja o resultado. Chega de copiar tokens entre abas.

Clientes de API comuns

Aqui estão três clientes de API amplamente usados, listados em ordem alfabética. Eles são exemplos, não recomendações. Escolha o que melhor se adequa às necessidades da sua equipe e às políticas de segurança.

Bruno

Bruno é um cliente de API leve, com foco em uso local, para criar e testar solicitações de API. É gratuito e de código aberto. As coleções são salvas como arquivos de texto simples na sua própria máquina, para que você possa manter as solicitações sob controle de versão no Git e compartilhá-las por meio dos seus repositórios existentes. O Bruno importa arquivos OpenAPI (Swagger) e oferece suporte a ambientes, variáveis secretas e scripts.

Insomnia

Desenvolvido pela Kong, o Insomnia é um cliente de API multiplataforma conhecido por sua interface limpa e intuitiva. Assim como o Bruno, é gratuito e de código aberto. Ele lida com muitos protocolos, incluindo REST, GraphQL, gRPC e WebSockets, e você pode armazenar projetos localmente, sincronizá-los com o Git ou armazená-los na nuvem. O Insomnia também importa arquivos OpenAPI (Swagger) e adiciona plugins para fluxos de trabalho personalizados.

Postman

Como uma das plataformas de API mais amplamente adotadas, o Postman oferece às equipes um único lugar para projetar, testar, documentar e monitorar APIs. Ele é gratuito para baixar para macOS, Windows e Linux, e também roda em um navegador web. O Postman oferece suporte a importações OpenAPI (Swagger), ambientes, scripts de pré-solicitação e de teste, e execuções automatizadas de coleções. Seus espaços de trabalho compartilhados facilitam a colaboração da equipe.

Conectando seu cliente de API ao Ootbi

Etapa 1: Instale um cliente de API

Cada cliente terá seu próprio processo de autenticação, que deve ser capaz de importar o arquivo JSON do Swagger.

Etapa 2: Teste a conectividade

Execute uma solicitação Simples, como a que retorna sessões ativas. Um código de status 200 significa que o Ootbi aceita seu token e a conexão funciona. A resposta lista as sessões atuais no cluster, incluindo a sua.

Executando suas primeiras chamadas de API do Ootbi

Exemplo 1: Recuperar informações do cluster

Envie a solicitação Obter informações gerais sobre clusters. A resposta é detalhada: além dos detalhes do cluster e dos nós, ela lista os serviços do Ootbi em execução no cluster e suas versões, informações que você não encontrará reunidas em um único lugar na interface.

Exemplo 2: Verificar atualizações disponíveis

Envie a solicitação atualizações atualmente disponíveis usando o Id do seu cluster. A resposta mostra sua versão atual e qualquer versão disponível.

Na prática, uma ferramenta central de monitoramento de atualizações executaria essa chamada em uma agenda, salvaria a versão atual e sinalizaria quando uma atualização ficasse disponível. Também existe uma versão dessa solicitação por nó, o que ajuda a identificar um nó que ficou para trás em um cluster com vários nós.

Exemplo 3: Coletar dados de usuários e eventos

Para um exemplo focado em conformidade, experimente duas solicitações:

• Retorna lista de usuários de gerenciamento: Retorna todos os usuários de gerenciamento com sua função e nível de acesso. Crie um novo usuário somente leitura (função de Monitoramento) na interface, execute a solicitação novamente e o novo usuário aparecerá imediatamente, uma forma rápida de ver que a API e a interface exibem os mesmos dados.

• Eventos: Retorna eventos com seu ID, origem, severidade e detalhes. Essas são as mesmas informações que você obteria do syslog, mas como JSON estruturado que não precisa de parsing. Está pronto para entrar em um SIEM ou ferramenta de relatórios.

Indo além: criando integrações

Exportando dados do Ootbi para um SIEM

Sua equipe de segurança quer eventos de infraestrutura Backup junto com todo o resto. Um fluxo de trabalho Simples:

1. Um script no seu servidor coletor autentica no Ootbi e solicita eventos em uma agenda.
2. Ele mantém apenas os novos eventos desde a última execução.
3. Ele os encaminha para o seu SIEM, onde podem ser correlacionados, pesquisados e gerar alertas.

Criando relatórios automatizados

A mesma abordagem viabiliza relatórios agendados. Colete usuários, chaves de acesso, buckets (incluindo o status de versionamento) e informações de licença semanalmente e transforme os resultados em um relatório consistente ou em um painel que sua equipe consulta todos os dias.

Integrando com fluxos de trabalho de TI existentes

• Sistemas de chamados: Abra um chamado automaticamente quando um evento de alta severidade aparecer ou quando uma atualização ficar disponível.

• Plataformas de monitoramento: Adicione dados de integridade e capacidade do Ootbi aos painéis que sua equipe de operações já usa.

• Ferramentas internas: Incorpore o Ootbi ao seu portal de provisionamento, por exemplo para criar usuários ou buckets como parte do onboarding de uma nova equipe ou cliente.

Com assistentes de codificação com IA, criar essas pequenas integrações está mais fácil do que nunca, mesmo que você não se considere um desenvolvedor.

Conclusão

A API REST do Ootbi estende o Ootbi muito além da interface web. Ela vem integrada em cada appliance, documentada via Swagger e disponível para qualquer pessoa que possua um Ootbi. Garanta que você escolha um cliente de API que seja fácil de explorar, testar e, eventualmente, automatizar fluxos de trabalho orientados por API.

Seja você um administrador de TI, um desenvolvedor, um MSP ou uma equipe de segurança, a API do Ootbi pode ajudar a simplificar operações, melhorar a visibilidade e incorporar sua infraestrutura Backup aos seus processos corporativos existentes. Abra o Swagger no seu cluster e veja o que você consegue construir.