Skip to main content
GET
Get

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

databaseId
string
required

The database's id (UUID), from databases.list.

Response

The database.

id
string
required
name
string
required

Customer-chosen database name — unique within the environment. 2-62 chars of lowercase letters, digits, and hyphens, starting with a letter.

Pattern: ^[a-z][a-z0-9-]{1,61}$
environment
string
required

Slug of the environment the database belongs to.

Pattern: ^[a-z][a-z0-9-]{0,38}$
status
enum<string>
required
Available options:
provisioning,
resizing,
ready,
failed
region
string
required

Database region id (see regions.list). Immutable after provisioning.

replicas
enum<integer>
required

Topology: 0 creates a single-node database; 2 creates one primary plus two data replicas with synchronous quorum commits and continuous recovery.

Available options:
0,
2
host
string
required

Managed database endpoint — the in-platform hostname for SKU databases, "db.korve.app" for legacy ones.

port
integer
required
poolerPort
integer
required

PgBouncer transaction-pooling port. The primary port remains available for session-mode clients.

dbName
string
required
user
string
required
provider
string
required

Database backend generation the row lives on. Set at provisioning.

sku
string | null
required

Database SKU id (see the rate card via billing.get); null on legacy databases.

targetSku
string | null
required

Requested SKU while a zero-downtime HA resize is running; otherwise null.

allocatedStorageGb
integer | null
required

Actual allocated data-disk capacity. It grows with larger SKUs and remains allocated after a compute downsize because durable volumes cannot shrink.

resize
object | null
required

Durable progress for an active rolling resize; null when no resize is running.

liveStatus
enum<string>
required

Liveness from the instance's heartbeat: live when the last report is recent, stale once it lapses, unknown before the instance has ever reported.

Available options:
live,
stale,
unknown
lastSeenAt
string<date-time> | null
required

When the instance last reported in; null until the first heartbeat.

sizeBytes
integer | null
required

On-disk size in bytes from the latest heartbeat; null until the first report.

nodes
object[]
required

Instance topology for managed databases. Empty for legacy databases.

metrics
object | null
required

Latest one-minute operational sample; null until the node agent reports one.

createdAt
string<date-time>
required