Skip to main content
POST
Add a database to a service

Autorisations

Authorization
string
header
requis

API token (olab_…) created in Settings → API tokens or with orbitlab login.

En-têtes

X-OrbitLab-Org
string

Organization to act on (id or slug) for tokens that can access several organizations. Defaults to your first organization.

Paramètres de chemin

id
string
requis

Service id.

Corps

application/json
name
string
requis

Lowercase letters, digits, underscores (max 64).

username
string

Shared hosting only. Defaults to name (max 32).

engine
string

App only: postgres (default) or mysql.

connectionUrl
string

App only: attach a database already provisioned in the app's zone (postgres|mysql.<zone>.orbitlab.dev) instead of creating one. Env vars are left unchanged.

Réponse

database including the generated password (and connectionUrl for apps); envUpdated for apps.

The response is of type object.