Overview

The Kupe API is a REST API for managing tenant resources programmatically (clusters, secrets, members, and API keys) from CI pipelines, Terraform, or your own scripts. Use an API key for resource management and an ETag for safe concurrent updates where supported. Tenant deletion requires the owner to sign in.

Base URL

https://api.kupe.cloud/api/v1

How the API is organised

Most API routes are tenant-scoped:

/api/v1/tenants/{tenant}/...

That includes clusters, databases, secrets, members, API keys, and tenant settings.

Plan endpoints are the exception. These are public and do not require authentication:

/api/v1/plans
/api/v1/plans/{name}

What you can manage

Area	What the API covers
Clusters	Create, inspect, update, delete, and fetch connection details
Secrets	Create secret definitions, manage sync targets, inspect sync status, and delete the definition
Databases	Create, resize, and delete databases, bind them into cluster namespaces, rotate credentials
Members	Add members, change roles, and remove access
API keys	Create, list, and revoke tenant-scoped API keys
Tenant settings	Inspect tenant status and update plan or observability enforcement

Authentication model

Tenant-scoped routes use bearer authentication. Generate an API key in the console, then send it in CI, Terraform, scripts, or any other automation. Pick the narrowest role that gets the job done.

Concurrency and updates

Read-modify-write flows support optimistic locking with ETag and If-Match. Use that pattern when automation might race with another user or pipeline.

API vs Terraform

Use the API when you want:

direct scripting
custom integration logic
event-driven automation

Use Terraform when you want:

declarative state management
plan and apply workflows
drift detection and repeatable infrastructure changes

Recommended starting points

The reference section is generated from the OpenAPI spec, so it stays aligned with the API surface as the server evolves.