Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API Reference

HoneyBee Core Backend API reference.

Base URL

http://localhost:9002

Endpoints

Health Check

Check if Core is running.

GET /health

Response:

{
  "status": "ok"
}

Get Nodes

Get list of all registered nodes.

GET /api/v1/nodes

Response:

{
  "nodes": [
    {
      "node_id": 12345,
      "node_name": "my-node",
      "status": "Running",
      "node_type": "Full"
    }
  ]
}

Get Node Status

Get status of a specific node.

GET /api/v1/nodes/{node_id}

Response:

{
  "node_id": 12345,
  "node_name": "my-node",
  "status": "Running",
  "node_type": "Full",
  "honeypots": [
    {
      "pot_id": "cowrie-01",
      "pot_type": "cowrie",
      "status": "Running"
    }
  ]
}

Get Honeypots

Get list of all honeypots across all nodes.

GET /api/v1/honeypots

Response:

{
  "honeypots": [
    {
      "node_id": 12345,
      "pot_id": "cowrie-01",
      "pot_type": "cowrie",
      "status": "Running"
    }
  ]
}

WebSocket Proxy

Real-time updates via WebSocket on port 9003.

Connect: ws://localhost:9003

Messages: JSON Protocol v2 messages

Authentication

API authentication is planned for future versions.

Rate Limiting

Rate limiting is planned for future versions.

Next Steps