Documentation by ClonePartner

Start typing to search.

API Reference

Envoy Control Plane API

View Markdown

REST API for the Envoy ETL framework control plane. Manages tasks, connectors, job templates, jobs, runs, triggers, metrics, and API keys. Authentication Most endpoints require…

REST API for the Envoy ETL framework control plane. Manages tasks, connectors, job templates, jobs, runs, triggers, metrics, and API keys.

Authentication

Most endpoints require authentication via one of two methods:

  • API Key (recommended for programmatic access): Send an Authorization: Bearer <key> header. Create keys via POST /api/api-keys.
  • Session Cookie: Used by the web UI. Authenticate via /api/auth/login + /api/auth/verify-totp.

API details

  • Version: 1.0.0
  • Specification: OpenAPI 3.1.0
  • Example base URL: https://your-envoy.example.com

Servers declared by the specification

  • / — Current server

Guides

Endpoint groups

  • Health — Liveness check
  • Branding — Public branding configuration
  • Auth — Session-based authentication (login, setup, TOTP)
  • Tasks — Task definitions with versioned YAML
  • Export/Import — Task and job template bundle export/import
  • Runs — Task execution runs (standalone or via jobs)
  • Connectors — Named connector configurations (DB, API, file, etc.)
  • Triggers — Cron-based triggers on jobs
  • Metrics — Metrics configuration and data queries
  • Job Templates — Template YAML definitions with DAG of tasks
  • Dashboard Templates — Dashboard YAML definitions linked to job templates (snapshotted on job creation)
  • Dashboards — Job-bound dashboard instances with optional public share links
  • Public Dashboards — Unauthenticated read-only dashboard access via share token
  • Jobs — Instantiated templates with bound connectors and snapshotted YAML/task versions
  • Job Runs — Execution of a job (contains task runs)
  • Server — Server configuration and executor info
  • Users — User management (CRUD for admins, self-service for all)
  • AI — AI-powered task generation (requires ai.api_key in server config)
  • AI References — Instance-managed AI reference documents
  • Explorer Presets — Shared team presets for the Data Explorer
  • Executors — Executor registration and heartbeat (executor-key authenticated, internal)
  • Executor Callbacks — Executor-to-control-plane callbacks for run logs and completion (executor-key authenticated, internal)