# Envoy Control Plane API

> Source: https://docs.clonepartner.com/api-reference/

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

- [Authentication](/api-reference/authentication)
- [Pagination](/api-reference/pagination)
- [Errors](/api-reference/errors)

## Endpoint groups

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