Admin
Endpoints de cuenta, usuario, estado del sistema y versión.
Abrir →
Documentación API
La API de la plataforma CybrIQ.
314 endpoints organizados en 31 grupos de tags. Cada endpoint con método, ruta, resumen, un ejemplo curl listo para copiar y la especificación OpenAPI subyacente para los esquemas completos de petición/respuesta. Elige un grupo de tags abajo, o salta a la vista que los muestra todos.
Primeros pasos
1. Autenticación
Todas las peticiones se autentican con un token bearer. Obtén un token mediante POST /prime/webui/auth/login y pásalo en peticiones posteriores como Authorization: Bearer <token>. También se soporta inicio de sesión LDAP mediante POST /prime/webui/auth/ldaplogin.
2. URL base
Reemplaza <host> en los ejemplos curl por el nombre de host de tu despliegue de CybrIQ. Para despliegues gestionados como SaaS se proporciona en el aprovisionamiento; para despliegues gestionados por el cliente es el nombre de host de tu plano de control.
3. Formatos de respuesta
La mayoría de los endpoints devuelven JSON por defecto. Las exportaciones a CSV y PDF están disponibles en endpoints de tipo colección (por ejemplo, POST .../exportcsv, POST .../exportpdf).
4. ¿Necesitas acceso?
El acceso a la API se aprovisiona junto al despliegue de la plataforma. Reserva una sesión de trabajo para definir el alcance del acceso para tu entorno, o escribe a contact_us@cybriq.io para el paquete de partnership de seguridad y la especificación OpenAPI fuente.
Grupos de tags
31 grupos de tags, 314 endpoints.
Elige el área en la que estés trabajando.
Agents
Endpoints para gestionar agentes CybrIQ, conexiones sin agente y pollers de trabajadores.
Abrir →AssetProducer
Endpoints de reproducción y monitorización del productor de activos.
Abrir →Auth
Endpoints de autenticación, incluyendo inicio de sesión local y LDAP.
Abrir →Bom
Endpoints de componentes de la lista de materiales.
Abrir →Config
Endpoints de configuración de la plataforma.
Abrir →CrowdstrikeIntegration
Configuración de la integración con CrowdStrike.
Abrir →DataApi
API de datos para tipos de indicador y subindicador.
Abrir →Elements
Exportación masiva de elementos como CSV o PDF.
Abrir →EmergencyKey
Endpoints de búsqueda, estado y exportación de claves de emergencia.
Abrir →EventApi
Destinos de alarmas, registros de auditoría y exportación de eventos.
Abrir →General
Recuperación de logs de depuración y endpoints de utilidad general.
Abrir →GeneralConfig
Configuración general de plataforma: tags, ajustes de servidor, integraciones, licencias y SMTP.
Abrir →Integration
Endpoints de salud de integración y prueba de syslog.
Abrir →License
Endpoints de carga, recuperación de licencia y EULA.
Abrir →Location
Endpoints de metadatos de ubicación.
Abrir →Endpoints de envío de correo y notificaciones.
Abrir →NetApi
Endpoints de infraestructura de red: switches, puertos, políticas, infraestructura, motores de escaneo y análisis de riesgo.
Abrir →NetsApiAnalysis
Endpoints de análisis de red.
Abrir →Notification
Endpoints de configuración y envío de notificaciones.
Abrir →Peripherals
Endpoints de dispositivos periféricos, incluida la exportación.
Abrir →PolicyEngine
Endpoints de configuración y ejecución del motor de políticas.
Abrir →ReportManagerApi
Endpoints del gestor de informes para generar y exportar informes.
Abrir →Reports
Endpoints de recuperación y exportación de informes.
Abrir →SendNotification
Endpoints de envío de notificaciones.
Abrir →ServerSettings
Ajustes de plataforma del lado servidor.
Abrir →Tags
Endpoints de gestión de tags.
Abrir →TransformerDataApi
Endpoints de datos de transformer para pipelines de ingesta.
Abrir →UserAttributes
Endpoints de atributos definidos por el usuario.
Abrir →UserConfigTable
Endpoints de tabla de configuración de usuario.
Abrir →UserQuery
Endpoints de consultas guardadas por el usuario.
Abrir →El acceso a la API empieza con el despliegue de la plataforma.
Tokens preaprovisionados, especificación OpenAPI y soporte de integración se entregan con el proyecto.