API Reference
Base URL: https://flowtriq.com · All endpoints return JSON · All timestamps are UTC ISO 8601
Deploy API
Register Node
Register a new node using a workspace deploy token. Returns the node's API key and UUID. See Mass Deployment for the full guide and one-liner deploy command.
| Header | Value |
|---|---|
| Authorization* | Bearer YOUR_DEPLOY_TOKEN |
| Content-Type | application/json |
| Body Parameter | Required | Description |
|---|---|---|
| name | Yes | Display name for the node |
| ip | Yes | Public IP address of the server |
| location | No | Region or datacenter label |
| os | No | Operating system identifier |
| interface | No | Network interface to monitor (default: eth0) |
| HTTP | Error | Meaning |
|---|---|---|
| 401 | Invalid deploy token | Token is wrong, revoked, or missing |
| 400 | Node name / IP required | Missing required fields |
| 402 | Payment failed | No active subscription or payment issue |
| 409 | Duplicate name | A node with that name already exists |
Agent API
The agent API at https://flowtriq.com/api/v1/agent/* is used by ftagent to send metrics, report incidents, upload PCAPs, and receive configuration. See Agent API Reference for full endpoint documentation.
This API is not intended for direct use — the ftagent handles all communication automatically once configured.
Health Check
Returns system health status. No authentication required.
Dashboard APIs
The dashboard uses session-authenticated API endpoints at /api/dash/* for live metrics, PCAP management, workspace operations, and more. These endpoints require an active dashboard session and are not intended for external use. Manage your nodes, incidents, and settings through the dashboard.