API Reference

The Breakwater API provides programmatic access to all platform functions. All endpoints are served from:

https://breakwater.techgonecoastal.com/api/v1/

Authentication

All API requests require a valid session or API token. See Authentication for details.

Base URL

https://breakwater.techgonecoastal.com/api/v1

Response Format

All responses follow a consistent JSON format:

{
  "success": true,
  "data": { ... }
}

Error responses:

{
  "success": false,
  "message": "Error description",
  "error": "ERROR_CODE"
}

Rate Limits

Endpoint Type	Limit	Window
General API	1,000 requests	15 minutes
Auth endpoints	20 requests	15 minutes
Collector heartbeat	100 requests	1 minute

Available Endpoints

Module	Base Path	Description
Auth	/api/v1/auth	User authentication and tokens
Sites	/api/v1/sites	Site management
Devices	/api/v1/devices	Device inventory (Manifest)
Threats	/api/v1/threats	CVEs, advisories, threat actors (Lookout)
Forecast	/api/v1/forecast	Risk quantification, cost models
Channel	/api/v1/channel	Secure remote access, gateways, sessions
Collector	/api/v1/collector	Collector registration and heartbeat
Projects	/api/v1/projects	Helm project management
Catalog	/api/v1/catalog	Hardware catalog

Health Check

curl https://breakwater.techgonecoastal.com/health

{
  "status": "ok",
  "timestamp": "2026-03-09T22:00:00.000Z",
  "version": "1.0.0",
  "environment": "production"
}