Public API Reference
FlowLink provides a comprehensive REST API for programmatic management. All authenticated endpoints use httpOnly cookies (set via OAuth or email login). The API also acceptsAuthorization: Bearer <token> headers for CLI/API access.
Base URL
https://<your-org>.flowlink.io/apiSelf-hosted: https://your-domain.com/api
Authentication
# Cookie-based (browser)
fetch('/api/v1/catalog/services', { credentials: 'include' })
# Bearer token (CLI / API)
curl -H "Authorization: Bearer <token>" \
https://your-org.flowlink.io/api/v1/catalog/servicesEndpoints
| Method | Path | Description | Auth |
|---|---|---|---|
| GET | /api/health | Health check (no auth) | 🌐 |
| GET | /api/auth/providers | List available OAuth providers | 🌐 |
| POST | /api/auth/login | Email/password login → httpOnly cookie | 🌐 |
| POST | /api/auth/logout | Clear cookies, blacklist tokens | 🔐 |
| GET | /api/auth/me | Current user profile + is_admin | 🔐 |
| GET | /api/v1/forensics/timeline | Incident timeline with blast radius + anomalies | 🔐 |
| GET | /api/v1/forensics/reconstruct/{agent_id} | Agent activity reconstruction | 🔐 |
| POST | /api/v1/forensics/report | Generate compliance report | 🔐 |
| POST | /api/v1/forensics/snapshot | Create point-in-time state snapshot | 🔐 |
| GET | /api/v1/forensics/snapshots | List snapshots | 🔐 |
| GET | /api/v1/forensics/diff/{a}/{b} | Compare two snapshots | 🔐 |
| GET | /api/v1/catalog/services | Service catalog with health + risk | 🔐 |
| GET | /api/v1/catalog/summary | Business-level dashboard summary | 🔐 |
| GET | /api/v1/catalog/efficiency | Agent ROI and time savings | 🔐 |
| POST | /api/v1/changes | Create change request | 🔐 |
| GET | /api/v1/changes | List change requests | 🔐 |
| POST | /api/v1/changes/{id}/approve | Approve change | 🔐 |
| POST | /api/v1/changes/{id}/rollback | Rollback change | 🔐 |
| GET | /api/v1/ops/ask?q=... | AI Ops natural language query | 🔐 |
| GET | /api/orgs/{org_id}/map | Infrastructure map graph | 🔐 |
| POST | /api/shield/patterns | Manage shield patterns | 🔐 |
| GET | /api/policies | List policies | 🔐 |
| GET | /api/webhooks/alertmanager | Alertmanager webhook receiver | 🌐 |
SDK (Planned)
TypeScript and Python SDKs are planned for programmatic platform management:
// TypeScript SDK (planned)
import { FlowLink } from '@flowlink/sdk';
const fl = new FlowLink({ baseUrl: 'https://your-org.flowlink.io' });
// Get service catalog
const services = await fl.catalog.listServices();
// Create forensic timeline
const timeline = await fl.forensics.getTimeline({
from: new Date('2026-04-01'),
to: new Date(),
includeBlastRadius: true,
});
// Generate compliance report
const report = await fl.forensics.generateReport({
type: 'executive',
periodDays: 30,
});SDKs are in development. Track progress on GitHub.