Acceso a la página de documentación de la API interactiva

Utilice la página interactiva de documentación de la API para acceder a detalles técnicos de las API RESTful cómo realizar y experimentar cómo realizar solicitudes de API al servidor.

Acerca de esta tarea

La interfaz de usuario de documentación de la API proporciona descripciones y la capacidad de utilizar las siguientes interfaces de API REST:
Tabla 1. Interfaces de la API REST
API REST Descripción
/api/analytics Crear, actualizar y eliminar acciones personalizadas para las reglas.
/api/ariel Ver las propiedades de sucesos y flujos, crear búsquedas de sucesos y flujos y gestionar las búsquedas.
/api/asset_model Devuelve una lista de todos los activos del modelo. También puede listar todos los tipos de propiedad de activo disponibles y búsquedas guardadas, así como actualizar un activo.
/api/auth Cerrar e invalidar la sesión actual.
/api/config Ver y gestionar arrendatarios, dominios y extensiones de QRadar® .
/api/data_classification Ver todas las categorías de nivel alto y bajo, QRadar Registros de identificador (QID) y correlaciones de sucesos. También puede crear o editar registros de QID y correlaciones.
/api/forensics Gestionar recuperaciones y casos de capturas.
/api/gui_app_framework Instalar y gestionar las aplicaciones que se crean utilizando la GUI del kit de desarrollo de software del marco de aplicaciones.
/api/help Devuelve una lista de funciones de la API.
/api/qrm Gestionar grupos de búsquedas guardadas de QRM, grupos de preguntas, grupos de simulaciones, grupos de búsquedas guardadas de topología y grupos de modelos.
/api/qvm Recupera activos, vulnerabilidades, redes, servicios abiertos y filtros. También puede crear o actualizar tíquets de remediación.
/api/reference_data Ver y gestionar las recopilaciones de datos de referencia.
/api/scanner Ver, crear o iniciar una exploración remota que está relacionada con un perfil de exploración.
/api/services Realizar tareas como búsquedas de WHOIS, búsquedas de exploración de puertos, búsquedas de DNS y búsquedas de DIG. También puede recuperar los datos de geolocalización de una dirección IP o un conjunto de direcciones IP.
/api/siem Ver, actualizar y cerrar infracciones. También puede añadir notas y gestionar razones de cierre de infracciones.
/api/staged_config Recuperar la configuración transitoria de usuarios, hosts, notificaciones, redes remotas y servicios remotos. También puede iniciar o ver el estado de una acción de despliegue y actualizar y suprimir reglas de Yara.
/api/system Gestionar hosts de servidores, interfaces de red, y reglas de cortafuegos.

Procedimiento

  1. Para acceder a la interfaz interactiva de documentación de la API, introduzca la siguiente dirección URL en su navegador web: https://ConsoleIPaddress/api_doc/.
  2. Seleccione en la lista la versión de la API que quiera utilizar.
  3. Vaya al punto final al que desea acceder.
  4. Lea la documentación del punto final y complete los parámetros de solicitud.
  5. Haga clic en Probar para enviar la solicitud de API a su consola y recibir una respuesta con el formato adecuado en HTTPS.
    Nota: Al pulsar Pruébelo, la acción se realiza en el sistema QRadar . No todas las acciones se pueden deshacer, por ejemplo, no puede reabrir una infracción una vez cerrada.
  6. Revise y recopile la información que necesita para integrar con QRadar.