Acessando a página de documentação da API interativa

Utilize a página de documentação da API interativa para acessar detalhes técnicos para APIs RESTful e experimente fazer solicitações da API para seu servidor.

Sobre esta tarefa

A interface com o usuário da documentação da API fornece descrições e a capacidade de usar as interfaces de API de REST a seguir:
Tabela 1. Interfaces da API REST
API de REST Descrição
/api/analytics Criar, atualizar e remover ações customizadas para regras.
/api/ariel Visualizar propriedades de evento e fluxo, criar procuras de evento e de fluxo e gerenciar procuras.
/api/asset_model Retorna uma lista de todos os ativos no modelo. Também é possível listar todos os tipos de propriedades de ativo e de procuras salvas disponíveis e atualizar um ativo.
/api/auth Efetue logout e invalide a sessão atual.
/api/config Visualizar e gerenciar locatários, domínios e extensões do QRadar® .
/api/data_classification Visualize todas as categorias de alto e baixo nível, registros do QRadar Identificador (QID) e mapeamentos de eventos. Também é possível criar ou editar registros QID e mapeamentos.
/api/forensics Gerenciar recuperações de captura e casos.
/api/gui_app_framework Instalar e gerenciar aplicativos que são criados usando o GUI Application Framework Software Development Kit.
/api/help Retorna uma lista de recursos da API.
/api/qrm Gerenciar grupos de procuras salvas, grupos de perguntas, grupos de simulação, grupos de procuras salvas de topologia e grupos modelo do QRM.
/api/qvm Recupera ativos, vulnerabilidades, redes, serviços abertos e filtros. Também é possível criar ou atualizar chamados de correção.
/api/reference_data Visualiza e gerencia coleções de dados de referência.
/api/scanner Visualize, crie ou inicie uma varredura remota relacionada a um perfil de varredura.
/api/services Executar tarefas, como consultas WHOIS, consultas de varredura de porta, consultas DNS e consultas DIG. Também é possível recuperar dados de localização geográfica para um IP ou conjunto de endereços IP.
/api/siem Visualizar, atualizar e fechar delitos. Também é possível incluir notas e gerenciar motivos de fechamento de delito.
/api/staged_config Recuperar configuração montada para usuários, hosts, notificações, redes remotas e serviços remotos. Também é possível iniciar ou ver o estado de uma ação de implementação e atualizar e excluir regras de Yara.
/api/system Gerenciar os hosts do servidor, interfaces de rede e regras de firewall.

Procedimento

  1. Para acessar a interface de documentação interativa da API, digite o seguinte endereço URL em seu navegador da Web: https://ConsoleIPaddress/api_doc/.
  2. Selecione a versão da API que você deseja usar na lista.
  3. Vá para o terminal que você deseja acessar.
  4. Leia a documentação de terminal e conclua os parâmetros de solicitação.
  5. Clique em Try it out para enviar a solicitação de API ao seu console e receber uma resposta HTTPS formatada corretamente.
    Nota: ao clicar em Experimentar, a ação é executada no sistema QRadar . Nem todas as ações podem ser revertidas, por exemplo, não é possível reabrir uma ofensa após você fechá-la.
  6. Revise e reúna as informações necessárias para integrar com o QRadar.