Skip to main content

API Reference

Complete REST and WebSocket API documentation for EdgeFlow.

Overview

EdgeFlow provides a comprehensive REST API and WebSocket interface for programmatic control of your flows, nodes, and system configuration.

Base URL

http://localhost:1880/api/v1

Authentication

All API requests require authentication using an API key or JWT token. See the Authentication guide for details.

Quick Start

curl -X GET http://localhost:1880/api/v1/flows \
  -H "Authorization: Bearer YOUR_API_KEY"

Available Endpoints

Endpoint Description
GET /flows List all flows
POST /flows Create a new flow
GET /flows/{:id} Get flow by ID
PUT /flows/{:id} Update a flow
DELETE /flows/{:id} Delete a flow
POST /flows/{:id}/deploy Deploy a flow
GET /nodes List available node types
GET /settings Get system settings

WebSocket API

Connect to ws://localhost:1880/ws for real-time updates and node communication. 

const ws = new WebSocket('ws://localhost:1880/ws');
ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Received:', data);
};