setting

Runs CREATE DATABASE on the Windmill Postgres and grants access to the custom_instance_user

Changed on
post/settings/setup_custom_instance_pg_database/{name}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/settings/setup_custom_instance_pg_database/{name}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

namestring required

The name of the database to create

Request body

tag'ducklake' | 'datatable'

Response

status

successboolean required

Whether the operation completed successfully

errorstring nullable

Error message if the operation failed

tag'ducklake' | 'datatable'
used_by_workspacesstring[]

Workspaces that reference this database through a ducklake catalog or a datatable database of the kind being listed — 'instance' for the instance databases endpoint, 'external_instance' for the external cluster one. Computed at request time, not persisted, and only returned to superadmins.

workspace_idstring

The workspace a member created this database for as a fork copy. Only that workspace can import into it or point a fork at it.

Example response

{
  "success": true,
  "error": "Connection timeout"
}

Changes