Wildbox Documentation

Complete guides, API reference, and security documentation for the Wildbox Security Platform.

🚀

Get Started in 5 Minutes

Quickstart guide to deploy Wildbox with Docker Compose and verify services.

🔒

Security Status

Current security metrics, verification checks, and vulnerability tracking.

📚

API Reference

Complete API documentation with examples for all services and endpoints.

🚢

Deployment Guide

Production deployment procedures, security configuration, and operations.

Documentation by Role

👨‍💻 Developer

Start with , then explore and .

🛡️ Security Engineer

Review and for comprehensive security analysis.

⚙️ System Administrator

Follow for production setup.

Loading Quick Start guide...
Loading Credentials guide...
Loading Security Status...
Loading Security Policy...
Loading Security Audit...
Loading Deployment Guide...

API Documentation

Wildbox provides comprehensive REST APIs for all services. Complete OpenAPI documentation is available below with full endpoint specifications, request/response examples, and authentication details.

Note: To generate fresh API documentation from running services, execute: python3 scripts/generate-api-docs.py

Available APIs

API / Security Tools Service

Core security tool execution and orchestration platform.

Coming Soon

Identity & Authentication Service

User management, authentication, JWT tokens, and authorization endpoints.

Coming Soon

Data Service

Threat intelligence, IOCs, and security data aggregation.

Coming Soon

Guardian Service

Integration management, queue monitoring, and workflow orchestration.

Coming Soon

Responder Service

Incident response playbook execution and remediation automation.

OpenAPI Documentation

Agents Service

AI-powered threat analysis and machine learning security intelligence.

OpenAPI Documentation

API Documentation Index

View all APIs in a centralized documentation portal:

View Complete API Documentation Index →

Authentication

All API endpoints require authentication via Bearer token in the Authorization header:

Authorization: Bearer {your-jwt-token}

Common Headers

  • Authorization: Bearer {token} - JWT authentication token
  • Content-Type: application/json - Request content type
  • X-API-Key: {key} - Alternative API key authentication

Response Format

All APIs return JSON responses with consistent structure:

{
  "data": { /* response data */ },
  "status": "success",
  "timestamp": "2024-11-07T10:30:00Z"
}

Security Endpoints

API endpoints for security and compliance operations.

Authentication Endpoints

POST /auth/login

User login with email and password. Returns JWT token.

POST /auth/logout

User logout and token revocation.

POST /auth/refresh

Refresh JWT token for continued session.

Security Analysis Endpoints

POST /v1/analyze

Submit data for security analysis and threat assessment.

GET /v1/findings

Retrieve security findings and vulnerability assessments.

Integration Endpoints

GET /v1/integrations

List all configured security integrations.

POST /v1/integrations/{id}/execute

Execute security scan through specific integration.

Remediation Endpoints

POST /v1/playbooks/{id}/execute

Execute incident response playbook.

GET /v1/playbooks

List available response playbooks.

For complete API documentation with request/response examples, visit the OpenAPI Swagger UI links in the section.

Integration API Guide

Guide for integrating Wildbox with external security tools and platforms.

Webhook Integration

Wildbox supports incoming webhooks from external tools for automated alert ingestion and processing.

Service-to-Service Communication

All microservices communicate via internal APIs secured with X-Gateway-Secret headers. See for authentication details.

Data Export APIs

Export security data in various formats for integration with external systems:

  • JSON API for programmatic access
  • CSV export for spreadsheet analysis
  • SIEM integration feeds
  • Custom webhook deliveries

Getting Help with APIs

For API integration support:

  • Check individual service OpenAPI documentation
  • Review for example requests
  • Open GitHub Discussions for questions
  • Report bugs in GitHub Issues