←К документации

API overview

Stable

Назначение API v2, base URL и базовые принципы auth.

Обновлено: 4 февраля 2026 г.

API v2 — HTTP интерфейс Control Plane (CP) для управления tenants/БД и compute lifecycle.

Base URL

https://<cp-host>/v2
  • <cp-host> — публичный адрес CP (используется Console/CLI).
  • PostgreSQL подключения приложений идут не в CP, а в Gateway (<gateway-host>:5432).

Что можно делать через API

  • tenants: create/list/describe/delete
  • databases: create/list/describe/delete
  • compute lifecycle: start/stop/scale (в текущей версии scale = 0/1)
  • tokens/keys: управление API‑ключами и доступами (в зависимости от прав)

Аутентификация

  • HTTP: Authorization: Bearer <api-key>
  • Не используйте pg_user/pg_password для API. Это отдельные секреты только для PostgreSQL.