Provision
Provision a named database in the environment (production by default) and issue its credentials. You choose the name, SKU, and region; multiple databases per environment are allowed under distinct names.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The organization's id (UUID) or slug — either form is accepted.
The project's id (UUID) or slug — either form is accepted.
Query Parameters
Environment slug to scope this operation to. Defaults to "production". An environment that does not exist on the project answers 404. The database is created in the addressed environment.
^[a-z][a-z0-9-]{0,38}$Body
Database name: 2-62 chars of lowercase letters, digits, and hyphens, starting with a letter. Unique within the environment.
^[a-z][a-z0-9-]{1,61}$Database SKU id (see the rate card via billing.get). Sizes the dedicated instance. Required — there is no default size.
Database region id (see regions.list). Required; immutable after provisioning.
Topology: 0 is single-node; 2 is HA with two replicas. Defaults to 0. HA requires the platform continuous-backup destination to be configured.
0, 2 Response
Database provisioned. The connection string is shown once; store it securely. Rotate to obtain a new one.
The database's id — addresses it in every other operation.
Customer-chosen database name — unique within the environment. 2-62 chars of lowercase letters, digits, and hyphens, starting with a letter.
^[a-z][a-z0-9-]{1,61}$provisioning, resizing, ready, failed Full postgres:// connection string including the password. Shown exactly once — it is never retrievable later.