deploy.host-database.create

Give a pooled app a Postgres database on its pool host; the app gets DATABASE_URL at its next start

POST /deploy/api/apps/{id}/host-databaseIAM deploy:ManageHostDatabaseChanges state

One Postgres per pool host, a database and role per app, on the host disk. No failover: a lost host is replaced and the database restored from its newest backup. Your own DATABASE_URL (or a managed Postgres binding) wins over this one.

Request syntax

POST /deploy/api/apps/{id}/host-database

Path parameters

  • idRequired

    string

    Constraints: uuid

Response

201 with `data`: `name`, the database’s and its role’s name; an app that already has one gets the same answer, and after a move to managed Postgres a new, empty one. 400 for an app not on pooled hosting, 409 while the app is being deleted, while an unprefixed managed Postgres binding gives its DATABASE_URL, or while the host still drops the database a move left.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • nameAlways

    string

    Name of the database and its role on the host

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow deploy:ManageHostDatabase on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud deploy host-database create id

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_deploy_host-database_create.