For the complete documentation index, see llms.txt. This page is also available as Markdown.

Management API

Automate e6data from your own code - manage clusters, catalogs, schedules, and access policies over the Management REST API.

Automate e6data from your own code: manage clusters and catalogs, wire up CI/CD, schedule refreshes, - all over the e6data REST API. This section is about managing resources and automating workflows; running SQL and connecting BI tools is covered separately.

What this covers

In scope
Out of scope

Managing clusters, catalogs, schedules, and access policies over the Management API

Running SQL and connecting tools

Credentials and authentication for automation

Account-wide admin (tenants, workspace lifecycle, SSO) - your e6data admin or the Console

Automation recipes (scale-then-suspend, scheduled refresh, CI gates, RBAC-as-code)

Cluster and catalog concepts - the product docs

A developer checklist (polling, errors, pagination, idempotency, secrets)

Audience: application developers, data engineers, and platform/SRE teams automating against e6data. Everything here is self-serve and uses standard HTTPS + Bearer tokens.

CLI and SDKs

There is no separate CLI or SDK to install - the programmatic interface is the REST API. Drive it with curl, your language's HTTP client, or a client generated from the API's OpenAPI/Swagger spec.

  • Codegen - the Management API publishes an auto-generated OpenAPI/Swagger spec you can use to generate a typed client in your language.

  • Querying from code - use curl or any HTTP client against the HTTP query API, or the e6data Python connector (a separate pip-installable package for executing SQL, not resource management).

Reference

  • OpenAPI/Swagger - available from your workspace API host for client generation.

  • Get your <HOST>, cluster names, and tokens - the e6data Console → Settings.

Placeholders used in this section: <HOST> (your workspace API host), <CLUSTER> (a cluster name), <CATALOG> (a catalog name), e6sa_… / e6pat_… (your token).

Last updated

Was this helpful?