Skip to content

Documentation by ClonePartner

Documentation API Reference

Documentation API Reference

Start typing to search.

Overview

Introduction to Envoy

Getting Started

Installation and deployment choices
First-time setup
UI quickstart
CLI quickstart

Core Concepts

Architecture
Run lifecycle
Glossary

UI Guide

Tasks and runs
Job templates and jobs
Connectors
Data Explorer
Monitor and control job runs
Dashboards and public dashboards
Manage AI references
Scheduled triggers
Use the home dashboard
Use list and bulk actions
Users, settings, and authentication
AI assistant

Guides

CLI commands, configuration, and logs
Move tasks and job templates between environments
Configure a job between runs
Author an operational dashboard
Author a production task
Build an idempotent migration
Design template arguments
Override a task for one job
Use Data Explorer presets in practice
Enable public dashboard inputs and actions

Task Reference

Task structure and execution model
Step types
Job templates
JSONata expressions
Task patterns
Debugging tasks and runs
Metrics reference
Mapping database and sync_record
Data Explorer presets
AI assistant and reference behavior
Arguments reference
Job configuration reference
Masking, loops, and error handling

Connector Reference

Catalog connectors and connected accounts
Connector reference
Truto connector

Dashboard Reference

Dashboard schema and widgets

API Reference

Deployment

Docker deployment
Remote Docker deployment
Azure deployment
Customer builds and connector catalogs
Server configuration
Control plane and executors
Seed import and upgrades
Backups and upgrades
Branding and white-label configuration

Security

RBAC, secrets, and hardening
Configure OAuth redirect URIs

Operations

Metrics and observability
Run and log retention
Store run logs in VictoriaLogs
Live run monitoring

Extending Envoy

Extend connectors and steps

Troubleshooting

Troubleshooting

Recipes

Curated recipes

API Reference

Health

Liveness check

Liveness check

Endpoints

GET Health check — /api/health

PreviousArchive a job NextBranding

On this page

Endpoints

Documentation

Overview

Introduction to Envoy

Getting Started

Installation and deployment choices
First-time setup
UI quickstart
CLI quickstart

Core Concepts

Architecture
Run lifecycle
Glossary

UI Guide

Tasks and runs
Job templates and jobs
Connectors
Data Explorer
Monitor and control job runs
Dashboards and public dashboards
Manage AI references
Scheduled triggers
Use the home dashboard
Use list and bulk actions
Users, settings, and authentication
AI assistant

Guides

CLI commands, configuration, and logs
Move tasks and job templates between environments
Configure a job between runs
Author an operational dashboard
Author a production task
Build an idempotent migration
Design template arguments
Override a task for one job
Use Data Explorer presets in practice
Enable public dashboard inputs and actions

Task Reference

Task structure and execution model
Step types
Job templates
JSONata expressions
Task patterns
Debugging tasks and runs
Metrics reference
Mapping database and sync_record
Data Explorer presets
AI assistant and reference behavior
Arguments reference
Job configuration reference
Masking, loops, and error handling

Connector Reference

Catalog connectors and connected accounts
Connector reference
Truto connector

Dashboard Reference

Dashboard schema and widgets

API Reference

Deployment

Docker deployment
Remote Docker deployment
Azure deployment
Customer builds and connector catalogs
Server configuration
Control plane and executors
Seed import and upgrades
Backups and upgrades
Branding and white-label configuration

Security

RBAC, secrets, and hardening
Configure OAuth redirect URIs

Operations

Metrics and observability
Run and log retention
Store run logs in VictoriaLogs
Live run monitoring

Extending Envoy

Extend connectors and steps

Troubleshooting

Troubleshooting

Recipes

Curated recipes