v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB

Databases

Get a database

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_database, delete_database, write_database, read_branch, delete_branch, create_branch, delete_production_branch, connect_branch, connect_production_branch, connect_production_read_only_branch, delete_branch_password, delete_production_branch_password, delete_production_read_only_branch_password, read_deploy_request, create_deploy_request, approve_deploy_request, read_comment, create_comment, restore_backup, restore_production_branch_backup, read_backups, write_backups, delete_backups, delete_production_branch_backups, write_branch_vschema, write_production_branch_vschema

OAuth Scopes

Resource	Scopes
Organization	read_databases
Database	read_database

get/organizations/{organization}/databases/{database}

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

Response

Returns a database

idstring required

The ID of the database

urlstring required

The URL to the database API endpoint

branches_urlstring required

The URL to retrieve this database's branches via the API

branches_countinteger required

The total number of database branches

open_schema_recommendations_countinteger required

The total number of schema recommendations

development_branches_countinteger required

The total number of database development branches

production_branches_countinteger required

The total number of database production branches

issues_countinteger nullable

The total number of ongoing issues within a database

multiple_admins_required_for_deletionboolean required

If the database requires multiple admins for deletion

readyboolean required

If the database is ready to be used

at_backup_restore_branches_limitboolean required

If the database has reached its backup restored branch limit

at_development_branch_usage_limitboolean required

If the database has reached its development branch limit

html_urlstring required

The URL to see this database's branches in the web UI

namestring required

Name of the database

State of the database

shardedboolean required

If the database is sharded

default_branch_shard_countinteger required

Number of shards in the default branch

default_branch_read_only_regions_countinteger required

Number of read only regions in the default branch

default_branch_table_countinteger required

Number of tables in the default branch schema

default_branchstring required

The default branch for the database

require_approval_for_deployboolean required

Whether an approval is required to deploy schema changes to this database

resizingboolean required

True if a branch is currently resizing

resize_queuedboolean required

True if a branch has a queued resize request

config_changingboolean required

True if a config change is in progress

config_change_queuedboolean required

True if a config change is queued for maintenance window

allow_data_branchingboolean required

Whether seeding branches with data is enabled for all branches

foreign_keys_enabledboolean required

Whether foreign key constraints are enabled

automatic_migrationsboolean nullable

Whether to automatically manage Rails migrations during deploy requests.

restrict_branch_regionboolean required

Whether to restrict branch creation to one region

insights_raw_queriesboolean required

Whether raw SQL queries are collected

planstring required

The database plan

insights_enabledboolean required

True if query insights is enabled for the database

production_branch_web_consoleboolean required

Whether web console is enabled for production branches

migration_table_namestring nullable

Table name to use for copying schema migration data.

migration_frameworkstring nullable

Framework used for applying migrations.

created_atstring required

When the database was created

updated_atstring required

When the database was last updated

schema_last_updated_atstring nullable required

When the default branch schema was last changed.

kind'mysql' | 'postgresql' required

The kind of database