v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

Postgresql

PostgreSQL Database Management

Return PostgreSQL databases

This function lists an account's PostgreSQL® databases.

Important:

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

get/Postgresql/list_databases

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_databases",
  "module": "Postgresql",
  "result": {
    "data": [
      {
        "database": "user_db",
        "disk_usage": 673,
        "users": [
          "db_user"
        ]
      }
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}