Sign in
setting

create a data table role on a Windmill-managed Postgres cluster

Changed on
post/settings/datatable_roles

Request

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

Request body

namestring required
cluster'instance' | 'external_instance'

The Windmill-managed Postgres cluster a data table role is a login on: Windmill's own (behind instance data tables) or the external instance cluster (behind external_instance ones). Defaults to instance.

take_overboolean

manage a Postgres role of that name that already exists on the cluster, replacing its password, instead of refusing it. A role with cluster-wide attributes or memberships is refused either way

Response

the created role

idstring required
namestring required
enabledboolean required
cluster'instance' | 'external_instance' required

The Windmill-managed Postgres cluster a data table role is a login on: Windmill's own (behind instance data tables) or the external instance cluster (behind external_instance ones). Defaults to instance.

in_useboolean

Whether any data table, in any workspace, lets someone connect as this role. Only set in a data table's available_roles.

Changes

  • 10d4f9f74501Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 54318efce822Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status