List databases
Retrieve a paginated list of all databases the authenticated API key has access to. Results are ordered by name and can be paginated using the limit and offset query parameters. Use the status, type, project_id, and search query parameters to narrow down the results - multiple filters combine with AND.
Authorizations
API key authentication. Pass your API key as a Bearer token in the Authorization header.
Query Parameters
Maximum number of items per page
1 <= x <= 10025
Number of items to skip
0 <= x <= 100000
Return only databases with this status. The status reflects the most recent lifecycle operation, for example ready, creating, updating, restoring, deleting, or error.
creating, ready, updating, passwordChange, passwordChangeFailed, deleting, error, dbDeletionFailed, restoring, restoringFailed, updatingExternalConnection "ready"
Return only databases of this engine type. postgresql - PostgreSQL. mariadb - MariaDB. mysql - MySQL. redis - Redis. valkey - Valkey.
postgresql, mariadb, mysql, mongodb, redis, valkey "postgresql"
Return only databases that belong to this project.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Return only databases whose name or display name contains this text. Matching is case-insensitive.
1 - 100"my-app"
Response
Default Response
List of items
Total number of items matching the query
0 <= x <= 1000042
Current pagination offset
0 <= x <= 100000
Current pagination limit
1 <= x <= 10025