Skip to main content

​
Spark REST API

The Spark REST API provides programmatic access to workflow scheduling and automation features. Manage workflows, schedules, and monitor executions.

​
Base URL

http://localhost:8002/api/v1

​
Quick Start

# Start Spark with API enabled
spark start --api --port 8002

# API available at http://localhost:8002/api/v1
# Swagger docs at http://localhost:8002/docs

​
Core Endpoints

Workflows

Create and manage automated workflows

Schedules

Configure cron schedules

Executions

Monitor workflow executions

History

Coming Soon: Execution history and logs

​
Authentication

  • API Key
  • Bearer Token
curl -X GET http://localhost:8002/api/v1/workflows \
  -H "X-API-Key: your-api-key"

​
Interactive Documentation

# Start Spark
spark start --api

# Open Swagger UI
open http://localhost:8002/docs

​
Next Steps

Workflows API

Manage workflows

Schedules API

Configure schedules

Executions API

Monitor executions

Quick Start

Get started with Spark