Return PostgreSQL databases

This function lists an account's PostgreSQL® databases.

Important:

When you disable the Postgres role, the system disables this function.

Authorizations:

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  Postgresql \
  list_databases

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_databases",
  • "module": "Postgresql",
  • "result": {
    • "data": [
      • {
        • "database": "user_db",
        • "disk_usage": 673,
        • "users": [
          • "db_user"
          ]
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}