---
title: "List databases."
method: GET
path: "/v1/databases"
tags: ["Database"]
---

# List databases.

`GET /v1/databases`

## Request

- Base URL: `https://api.scalix.world`
- URL: `https://api.scalix.world/v1/databases`
- Auth: HTTP bearer

Lists the project's databases. `include_deleted=true` also returns
soft-deleted databases still inside the recovery grace window.

## Query parameters

- `include_deleted` boolean

## Response `200`

Databases in the project

- ListDatabasesResponse: Databases in the project.
  - `databases` DatabaseJson[], required
    - `id` string, required: Database id (UUID).
    - `name` string, required: Display name.
    - `pg_database` string, nullable: Physical PostgreSQL database name (`db_<hex>`).
    - `tenant_id` string, nullable: Tenant id backing this database on the compute plane.
    - `status` string, required: `active` or `deleting` (soft-deleted, inside the recovery grace window).
    - `created_at` string, nullable: RFC 3339 creation time.
    - `isolation` string, required: Isolation tier: `shared` or `dedicated`.
    - `pg_version` string, required: PostgreSQL major version this database runs (`16`, `17`, or `18`).
    - `deleted_at` string, nullable: Soft-delete timestamp, when `status` is `deleting`.
  - `delete_grace_days` integer, nullable: Days a soft-deleted database stays restorable.

## Other responses

- `401`: Missing or invalid API key

---

[API](https://skmtc.dev/scalix/apis/scalix-cloud-api.md) · [All operations](https://skmtc.dev/scalix/apis/scalix-cloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scalix/apis/scalix-cloud-api/revisions/2c04ca0a90bb?raw)
