Create a Tenant

Stable

How to create a tenant and what you must save immediately after creation.

Updated: March 5, 2026

Creating a tenant is the first real step after receiving an API key. The tenant becomes the container for all future databases and shared connection credentials.

What is sent on creation

At minimum, you only need name.

Example through REST:

POST /v2/tenants
Authorization: Bearer <api-key>
Content-Type: application/json
{
  "name": "acme"
}

What the platform returns

The response usually includes:

  • tenant;
  • pg_user;
  • pg_password;
  • dsn_template.

What to do immediately after the response

  • save pg_user;
  • save pg_password;
  • save dsn_template;
  • put the secrets into Secret Manager, CI secrets, or another protected system.

Naming requirements

Use a PostgreSQL-friendly name:

  • Latin letters;
  • digits;
  • _ / $;
  • no spaces and no Cyrillic.

What is important not to confuse

  • an API key is for the Control Plane, Console, and CLI;
  • pg_user / pg_password are for PostgreSQL connections through Gateway.

These two sets of secrets belong to different layers of the platform.

Why this matters

A tenant is not just a catalog object. At this step, you receive the main access path to all future databases. If credentials are lost or stored insecurely, further work becomes both harder and less safe.