Skip to content

Segurança

API Firewall

Esse produto está em fase beta

O API Firewall é uma ferramenta desenvolvida para proteger sua API, ao enviar a especificação da sua API utilizando o padrão Swagger/OpenAPI será criado automaticamente as regras de segurança necessárias a fim de protegê-la de todas as requests que não seguirem as especificações descritas. O host especificado no arquivo deve corresponder ao selecionado no painel.

Arquivos de configuração OpenAPI

Como adicionar um arquivo

É possível fazer o upload de arquivos yaml ou json que seguem o padrão OpenAPI podendo existir múltiplos arquivos de especificações OpenAPI distintos (não é permitido o uso de referências de arquivos).

api-firewall-upload

api-firewall-upload2

O parâmetro "servers" é utilizado para definir quais serão as urls em que o api-firewall atuará, durante o upload, caso ele não for especificado no arquivo, aparecerá um pop-up solicitando uma url padrão para o api-firewall, os paths informados na configuração OpenAPI serão validadas a partir da url informada.

api-firewall-servers

No painel, é possível verificar os endpoints e métodos configurados nos arquivos OpenAPI e futuramente será possível definir ações específicas para cada endpoint e arquivo OpenAPI, atualmente permitimos apenas a ação de simular, que gera eventos, mas não realiza nenhuma ação de bloqueio, oferecendo visibilidade sobre o tráfego da sua API.

api-firewall-paths

Como ativar/desativar um arquivo

É possível alterar o estado de uma configuração do api-firewall, permitindo a ativação e desativação de um ou mais arquivos, quando um arquivo é desativado ele não atua sobre nenhuma requisição. Para desativar algum arquivo, é necessário clicar no botão especificado na imagem abaixo:

api-firewall-change-status

Como remover um arquivo

Caso queira remover algum arquivo de configuração OpenAPI, basta clicar no botão de lixeira, conforme mostra a imagem a seguir:

api-firewall-delete