Databases & storage

Database connection details, backups, and SQL access require permissions beyond the standard service-key categories. Use an appropriately authorized account key for those operations. Restore and SQL operations can overwrite data.

GET List engines ↗

/api/hangar/engines

Discover supported database engines, versions, and provisioning capabilities..

GET List database extensions ↗

/api/hangar/extensions

Read the curated PostgreSQL extension catalog available during database creation..

GET Get database metrics ↗

/api/services/{id}/db/metrics

Read engine-specific database metrics, grouped for inspection..

PATCH Set storage ↗

/api/services/{id}/storage

Change the provisioned storage of a managed database or bucket without changing its compute plan..

POST Create database ↗

/api/databases

Provision a managed database in a project and environment using a supported engine and plan..

GET Get database connection ↗

/api/services/{id}/connection

Read connection details and credentials for a database you can access.

GET List backups ↗

/api/services/{id}/backups

List the backup records for a managed database..

POST Create backup ↗

/api/services/{id}/backups

Start an on-demand backup of a managed database..

POST Restore backup ↗

/api/services/{id}/backups/{backupId}/restore

Restore a selected backup into its database.

POST Execute a SQL query ↗

/api/services/{id}/db/console

Run a SQL query against a managed database.

POST Rotate database credentials ↗

/api/services/{id}/db/password

Change a managed database’s password and invalidate the previous credential..

POST Set database external access ↗

/api/services/{id}/db/access

Enable or disable external connections for a supported database..

POST Set database allowlist ↗

/api/services/{id}/db/allowlist

Set the source CIDRs allowed to connect to an externally accessible database..

POST Set database TLS ↗

/api/services/{id}/db/tls

Enable or disable external TLS for a supported database..