REST API

Downloads

CLI, helpers, and machine-readable specs for working against the Etlworks REST API.

Etlworks CLI

The CLI wraps the REST API for human use at the terminal: auth, deploy, run, monitor, audit. Same auth as the API (API key or JWT), so what you script in Bash you can hand off to ops.

etlworks CLI

Cross-platform binary (macOS, Linux, Windows). Authenticate once, run flows and inspect runs from a terminal or CI job.

Docs & download

Postman collection

Curated Postman collection covering the highest-traffic 80 endpoints: flows, executions, connections, schedules, audit. Drop in your API key and start poking.

Etlworks REST API: Postman

Coming soon. In the meantime, every example in the examples page works as a one-liner cURL you can paste into Postman manually.

Notify me

OpenAPI 3 spec

OpenAPI 3.1 specification of the public automation API: authentication, API keys, flows, runs, executions, schedules, connections, formats, listeners, import and export, SQL, connector metadata, webhooks, messages, the CLI, search, audit and the recycle bin. Every operation in it is checked against the application source on each build. Generate a client with openapi-generator, or load it into Postman, Insomnia or any OpenAPI viewer.

etlworks-api.openapi.yaml

126 operations across 21 groups. Also available as JSON. The AI Agent API has its own spec.

Download YAML

Starter scripts

Minimal, dependency-light wrappers. Drop into your project and edit. Same shape as the AI Agent client scripts so they sit naturally beside each other.

Python · Bash · PowerShell starters

Coming soon. The recipes on the examples page are self-contained: copy what you need today and we'll publish packaged starters here next.

View examples

On-prem installer

Self-host Etlworks (cloud + agent + UI) inside your network. The REST API is identical to Etlworks Cloud; only the base URL differs.

Etlworks self-hosted

Linux, Windows, and Docker images. Request a download link and we'll provision your installer + license.

Request installer

Building something on the API?

We'd like to hear about it. product@etlworks.com goes straight to the team that owns the REST surface, if you need an endpoint that isn't there yet, that's the right address.