Rename Database

PATCH /v1/databases/{uuid}

Change a database's name, the label only you see. Its name inside MariaDB (db_name) never changes, so connected apps and their variables stay as they are. Requires Databases update.

Request body

name string
Required. 1–64 characters, no control characters, unique in the account.

Response (200 OK)

The renamed database, {"database": {…}} (database object).

Errors

400
invalid request body, name is required, or Database name must be 1-64 characters, with no control characters.
403
No Databases update, no active account, or no managed databases on the plan.
404
database not found.
409
name_taken: A database with this name already exists.
quota_paused: the database is paused over your plan's database limit, and a paused database can't be renamed.
database_status: Not possible while the database is deleting.
503
databases_unavailable.
Request
curl -X PATCH "https://api.ngris.com/v1/databases/019c2a41-7d3e-7b52-a1c4-5e9f0b3d6a18" \ -H "X-API-KEY: <your_api_key>" \ -H "Content-Type: application/json" \ -d '{ "name": "orders" }'
Response — 200 OK
{ "database": { "uuid": "019c2a41-7d3e-7b52-a1c4-5e9f0b3d6a18", "name": "orders", "engine": "mariadb", "status": "ready", "placement": "shared", "db_name": "app_orders_db_k3x9q2tm", "host": "mariadb-apps.ngris-appdb.svc.cluster.local", "port": 3306, "size_bytes": null, "size_measured_at": null, "quota_paused": false, "connected_app_count": 1, "user_count": 1, "created_at": "2026-10-18T09:00:00Z", "updated_at": "2026-10-18T10:30:00Z" } }
Response — 409 (paused)
{ "error": "<why the database is paused and how to make room>", "code": "quota_paused", "quota_paused": true, "quota_paused_resource": "database", "quota_paused_key": "managed_database", "quota_paused_limit": 3 }
On this page
Rename Database