Skip to main content
Managed named Postgres databases. Creation is always explicit — databases are never provisioned automatically with apps or deploys — and each environment can hold several, addressed by id. Credentials are issued once and rotatable on demand.

databases.list

List the project’s databases across all environments — names and statuses, never credentials.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: read

Query parameters

Example

Responses

Response body (200)

An array of objects with these fields:

databases.get

Get one database’s status and connection details (never the password).
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: read

Path parameters

Example

Responses

Response body (200)

databases.insights

Per-query latency and throughput for the database, slowest first. Reports the instance’s latest drain (calls, total/mean time, p50/p99, rows read/written).
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: read

Path parameters

Query parameters

Example

Responses

Response body (200)

An array of objects with these fields:

databases.schema

Inspect non-system schemas, tables, views, columns, keys, and indexes using a read-only database connection.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: read

Path parameters

Example

Responses

Response body (200)

databases.browseRows

Page rows from one verified table or view with server-built filters and sorting. The database transaction is read-only.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: read

Path parameters

Request body

Example

Responses

Response body (200)

databases.query

Execute a single statement classified as read-only SQL with a database read-only transaction, five-second timeout, cancellation id, and hard row and byte limits.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: dangerous · sensitive (elevated blast radius)

Path parameters

Request body

Example

Responses

Response body (200)

databases.cancelQuery

Cancel one running query in the addressed customer database, never the control-plane database.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: dangerous · sensitive (elevated blast radius)

Path parameters

Example

Responses

Response body (200)

databases.queryHistory

Page the current operator’s retained query history, scoped to this project and database.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: member
  • Risk: read

Path parameters

Query parameters

Example

Responses

Response body (200)

databases.provision

Provision a named database in the environment (production by default) and issue its credentials. You choose the name, SKU, and region; multiple databases per environment are allowed under distinct names.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: admin
  • Billing: requires active organization billing — returns 402 otherwise.
  • Risk: write

Query parameters

Request body

Example

Responses

Response body (201)

databases.resize

Queue a rolling HA resize. Replicas restart one at a time, the primary switches to an already-resized replica, and the former primary resizes last. Existing connections reconnect during switchover. Volumes grow on larger SKUs but cannot shrink.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: admin
  • Billing: requires active organization billing — returns 402 otherwise.
  • Risk: write

Path parameters

Request body

Example

Responses

Response body (202)

databases.rotatePassword

Rotate the database password. The old password stops working immediately.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: admin
  • Risk: write · sensitive (elevated blast radius)

Path parameters

Example

Responses

Response body (200)

databases.delete

Delete the database and all of its data. This cannot be undone.
  • Auth: Organization API key (Authorization: Bearer korve_...) or dashboard session.
  • Minimum role: owner
  • Risk: destructive · sensitive (elevated blast radius)

Path parameters

Example

Responses