Databases

Managed databases, replicas, endpoints and attachments.

Base https://api.nodion.com. Short paths needX-Nodion-Project unless the path already has/v2/projects/{id}. Request bodies are in the interactive docs.

GET/v2/databases

List databases in the current project

Scope readInteractive docs

POST/v2/databases

Create a database in the current project

Scope writeInteractive docs

GET/v2/projects/{id}/databases

List databases

Scope readInteractive docs

POST/v2/projects/{id}/databases

Create a database

Scope writeInteractive docs

GET/v2/databases/{id}

Get a database

Connection credentials are included only with the `db:credentials` scope (or a session / project key).

Scope readInteractive docs

PATCH/v2/databases/{id}

Upgrade the database package

Scope writeInteractive docs

DELETE/v2/databases/{id}

Delete a database

Scope writeInteractive docs

GET/v2/databases/{id}/metrics

Get database metrics

Scope readInteractive docs

GET/v2/databases/{id}/engine_metrics

Get database engine metrics

Scope readInteractive docs

GET/v2/databases/{id}/backups

List database backups and settings

Scope readInteractive docs

PATCH/v2/databases/{id}/backups/settings

Update database backup settings

Scope writeInteractive docs

POST/v2/databases/{id}/restore

Restore a database to a new fork at a point in time

Scope writeInteractive docs

GET/v2/databases/{id}/browse/namespaces

List schemas or databases for read-only browse

Scope readInteractive docs

GET/v2/databases/{id}/browse/tables

List tables and views in a namespace

Scope readInteractive docs

GET/v2/databases/{id}/browse/rows

Preview rows from a table (read-only)

Scope readInteractive docs

GET/v2/databases/{id}/browse/keys

SCAN keys on a Valkey database

Opaque Redis SCAN cursor in `next_cursor`. Last page has `next_cursor: null`.

Scope readInteractive docs

GET/v2/databases/{id}/browse/value

Preview a Valkey key value

Scope readInteractive docs

GET/v2/databases/{id}/insights

Query stats, live sessions and unused indexes (Postgres, MySQL)

Scope readInteractive docs

GET/v2/databases/{id}/containers

List database containers

Scope readInteractive docs

GET/v2/databases/{id}/logs/history

Query historical database logs

Scope logs:readInteractive docs

POST/v2/databases/{id}/attachments

Attach a database to an application

Scope writeInteractive docs

PATCH/v2/database_attachments/{id}

Update a database attachment's bindings

Scope writeInteractive docs

DELETE/v2/database_attachments/{id}

Detach a database from an application

Scope writeInteractive docs

POST/v2/databases/{id}/replicas

Add a read replica

Scope writeInteractive docs

GET/v2/databases/{id}/ha

High availability status

Scope readInteractive docs

POST/v2/databases/{id}/ha

Enable high availability (async standby)

Scope writeInteractive docs

PATCH/v2/databases/{id}/ha

Update HA settings (auto-failover, async/sync mode)

Scope writeInteractive docs

DELETE/v2/databases/{id}/ha

Disable high availability

Scope writeInteractive docs

GET/v2/databases/{id}/cluster

ClickHouse cluster status

Scope readInteractive docs

POST/v2/databases/{id}/cluster

Enable a 3-node ClickHouse cluster

Scope writeInteractive docs

DELETE/v2/databases/{id}/cluster

Disable the ClickHouse cluster

Scope writeInteractive docs

POST/v2/databases/{id}/failover

Promote the HA standby (manual failover)

Scope writeInteractive docs

POST/v2/databases/{id}/endpoints

Enable public endpoints

Scope writeInteractive docs

DELETE/v2/databases/{id}/endpoints

Disable public endpoints

Scope writeInteractive docs

POST/v2/databases/{id}/allowed_cidrs

Set the source-IP allowlist for public endpoints

Scope writeInteractive docs

POST/v2/databases/{id}/pooler

Enable the connection pooler

Scope writeInteractive docs

DELETE/v2/databases/{id}/pooler

Disable the connection pooler

Scope writeInteractive docs

POST/v2/databases/{id}/pooler/endpoint

Enable public access to the connection pooler

Scope writeInteractive docs

DELETE/v2/databases/{id}/pooler/endpoint

Disable public access to the connection pooler

Scope writeInteractive docs

POST/v2/databases/{id}/pooler/allowed_cidrs

Set the source-IP allowlist for the public pooler

Scope writeInteractive docs

DELETE/v2/database_nodes/{id}

Delete a database node (replica)

Scope writeInteractive docs

GET/v2/applications/{id}/attachments

List an application's database attachments

Scope readInteractive docs