---
title: "Return PostgreSQL databases"
method: GET
path: "/Postgresql/list_databases"
tags: ["Postgresql", "PostgreSQL Database Management"]
---

# Return PostgreSQL databases

`GET /Postgresql/list_databases`

This function lists an account's PostgreSQL® databases.

**Important:**

  When you disable the [*Postgres* role](https://go.cpanel.net/serverroles), the system **disables** this function.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[]
      - `database` string — The database name.
      - `disk_usage` integer — The disk space that the database uses, in bytes.
      - `users` string[] — An array of database usernames. **Note:** If no users exist on a database, the function returns an empty array
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)
