id | string | — |
name | string | 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 | Slug of the environment the database belongs to. Pattern: ^[a-z][a-z0-9-]{0,38}$. |
status | string | One of: provisioning, resizing, ready, failed. |
region | string | Database region id (see regions.list). Immutable after provisioning. |
replicas | integer | Topology: 0 creates a single-node database; 2 creates one primary plus two data replicas with synchronous quorum commits and continuous recovery. One of: 0, 2. |
host | string | Managed database endpoint — the in-platform hostname for SKU databases, “db.korve.app” for legacy ones. |
port | integer | — |
poolerPort | integer | PgBouncer transaction-pooling port. The primary port remains available for session-mode clients. |
dbName | string | — |
user | string | — |
provider | string | Database backend generation the row lives on. Set at provisioning. |
sku | string or null | Database SKU id (see the rate card via billing.get); null on legacy databases. |
targetSku | string or null | Requested SKU while a zero-downtime HA resize is running; otherwise null. |
allocatedStorageGb | integer or null | Actual allocated data-disk capacity. It grows with larger SKUs and remains allocated after a compute downsize because durable volumes cannot shrink. |
resize | object or null | Durable progress for an active rolling resize; null when no resize is running. |
resize.direction | string | One of: up, down. |
resize.phase | string | One of: queued, preparing, growing-storage, resizing-replicas, switching-primary, resizing-former-primary, verifying, retrying. |
resize.progressPercent | integer | — |
resize.startedAt | string | Format: date-time. |
resize.estimatedCompletedAt | string | Format: date-time. |
liveStatus | string | Liveness from the instance’s heartbeat: live when the last report is recent, stale once it lapses, unknown before the instance has ever reported. One of: live, stale, unknown. |
lastSeenAt | string or null | When the instance last reported in; null until the first heartbeat. Format: date-time. |
sizeBytes | integer or null | On-disk size in bytes from the latest heartbeat; null until the first report. |
nodes | object[] | Instance topology for managed databases. Empty for legacy databases. |
nodes[].ordinal | integer | — |
nodes[].role | string | One of: primary, replica, witness. |
nodes[].region | string | — |
nodes[].status | string | — |
nodes[].metrics | object or null | Latest one-minute operational sample; null until the node agent reports one. |
nodes[].metrics.sampledAt | string | Format: date-time. |
nodes[].metrics.qps | number or null | Queries per second in the sample window. |
nodes[].metrics.readIops | number or null | — |
nodes[].metrics.writeIops | number or null | — |
nodes[].metrics.cpuPercent | number or null | — |
nodes[].metrics.memoryUsedBytes | integer or null | — |
nodes[].metrics.memoryLimitBytes | integer or null | — |
nodes[].metrics.directConnections | integer or null | — |
nodes[].metrics.pgbouncer | object | — |
nodes[].metrics.pgbouncer.clientActive | integer or null | — |
nodes[].metrics.pgbouncer.clientWaiting | integer or null | — |
nodes[].metrics.pgbouncer.serverActive | integer or null | — |
nodes[].metrics.pgbouncer.serverIdle | integer or null | — |
nodes[].metrics.pgbouncer.maxClientConnections | integer or null | — |
metrics | object or null | Latest one-minute operational sample; null until the node agent reports one. |
metrics.sampledAt | string | Format: date-time. |
metrics.qps | number or null | Queries per second in the sample window. |
metrics.readIops | number or null | — |
metrics.writeIops | number or null | — |
metrics.cpuPercent | number or null | — |
metrics.memoryUsedBytes | integer or null | — |
metrics.memoryLimitBytes | integer or null | — |
metrics.directConnections | integer or null | — |
metrics.pgbouncer | object | — |
metrics.pgbouncer.clientActive | integer or null | — |
metrics.pgbouncer.clientWaiting | integer or null | — |
metrics.pgbouncer.serverActive | integer or null | — |
metrics.pgbouncer.serverIdle | integer or null | — |
metrics.pgbouncer.maxClientConnections | integer or null | — |
createdAt | string | Format: date-time. |