Get a database

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{name} \
  --header 'Authorization: <api-key>'

{
  "id": "<string>",
  "url": "<string>",
  "branches_url": "<string>",
  "branches_count": 123,
  "open_schema_recommendations_count": 123,
  "development_branches_count": 123,
  "production_branches_count": 123,
  "issues_count": 123,
  "multiple_admins_required_for_deletion": true,
  "ready": true,
  "at_backup_restore_branches_limit": true,
  "at_development_branch_usage_limit": true,
  "data_import": {
    "state": "<string>",
    "import_check_errors": "<string>",
    "started_at": "<string>",
    "finished_at": "<string>",
    "data_source": {
      "hostname": "<string>",
      "port": 123,
      "database": "<string>"
    }
  },
  "region": {
    "id": "<string>",
    "provider": "<string>",
    "enabled": true,
    "public_ip_addresses": [
      "<string>"
    ],
    "display_name": "<string>",
    "location": "<string>",
    "slug": "<string>",
    "current_default": true
  },
  "html_url": "<string>",
  "name": "<string>",
  "state": "pending",
  "sharded": true,
  "default_branch_shard_count": 123,
  "default_branch_read_only_regions_count": 123,
  "default_branch_table_count": 123,
  "default_branch": "<string>",
  "require_approval_for_deploy": true,
  "resizing": true,
  "resize_queued": true,
  "allow_data_branching": true,
  "foreign_keys_enabled": true,
  "automatic_migrations": true,
  "restrict_branch_region": true,
  "insights_raw_queries": true,
  "plan": "<string>",
  "insights_enabled": true,
  "production_branch_web_console": true,
  "migration_table_name": "<string>",
  "migration_framework": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "schema_last_updated_at": "<string>",
  "kind": "mysql"
}

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, delete_branch_password, delete_production_branch_password, read_deploy_request, create_deploy_request, approve_deploy_request, read_schema_recommendations, close_schema_recommendations, 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

{name}

Get a database

curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{name} \
  --header 'Authorization: <api-key>'

{
  "id": "<string>",
  "url": "<string>",
  "branches_url": "<string>",
  "branches_count": 123,
  "open_schema_recommendations_count": 123,
  "development_branches_count": 123,
  "production_branches_count": 123,
  "issues_count": 123,
  "multiple_admins_required_for_deletion": true,
  "ready": true,
  "at_backup_restore_branches_limit": true,
  "at_development_branch_usage_limit": true,
  "data_import": {
    "state": "<string>",
    "import_check_errors": "<string>",
    "started_at": "<string>",
    "finished_at": "<string>",
    "data_source": {
      "hostname": "<string>",
      "port": 123,
      "database": "<string>"
    }
  },
  "region": {
    "id": "<string>",
    "provider": "<string>",
    "enabled": true,
    "public_ip_addresses": [
      "<string>"
    ],
    "display_name": "<string>",
    "location": "<string>",
    "slug": "<string>",
    "current_default": true
  },
  "html_url": "<string>",
  "name": "<string>",
  "state": "pending",
  "sharded": true,
  "default_branch_shard_count": 123,
  "default_branch_read_only_regions_count": 123,
  "default_branch_table_count": 123,
  "default_branch": "<string>",
  "require_approval_for_deploy": true,
  "resizing": true,
  "resize_queued": true,
  "allow_data_branching": true,
  "foreign_keys_enabled": true,
  "automatic_migrations": true,
  "restrict_branch_region": true,
  "insights_raw_queries": true,
  "plan": "<string>",
  "insights_enabled": true,
  "production_branch_web_console": true,
  "migration_table_name": "<string>",
  "migration_framework": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "schema_last_updated_at": "<string>",
  "kind": "mysql"
}

Authorizations

Authorization

string

header

required

Path Parameters

organization

string

required

The name of the organization the database belongs to

name

string

required

The name of the database

Response

Returns a database

string

required

The ID of the database

url

string

required

The URL to the database API endpoint

branches_url

string

required

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

branches_count

number

required

The total number of database branches

open_schema_recommendations_count

number

required

The total number of schema recommendations

development_branches_count

number

required

The total number of database development branches

production_branches_count

number

required

The total number of database production branches

issues_count

number

required

The total number of ongoing issues within a database

multiple_admins_required_for_deletion

boolean

required

If the database requires multiple admins for deletion

ready

boolean

required

If the database is ready to be used

at_backup_restore_branches_limit

boolean

required

If the database has reached its backup restored branch limit

at_development_branch_usage_limit

boolean

required

If the database has reached its development branch limit

data_import

object

required

Show child attributes

region

object

required

Show child attributes

html_url

string

required

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

name

string

required

Name of the database

state

enum<string>

required

State of the database

Available options:

pending,

importing,

sleep_in_progress,

sleeping,

awakening,

import_ready,

ready

sharded

boolean

required

If the database is sharded

default_branch_shard_count

number

required

Number of shards in the default branch

default_branch_read_only_regions_count

number

required

Number of read only regions in the default branch

default_branch_table_count

number

required

Number of tables in the default branch schema

default_branch

string

required

The default branch for the database

require_approval_for_deploy

boolean

required

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

resizing

boolean

required

True if a branch is currently resizing

resize_queued

boolean

required

True if a branch has a queued resize request

allow_data_branching

boolean

required

Whether seeding branches with data is enabled for all branches

foreign_keys_enabled

boolean

required

Whether foreign key constraints are enabled

automatic_migrations

boolean

required

Whether to automatically manage Rails migrations during deploy requests

restrict_branch_region

boolean

required

Whether to restrict branch creation to one region

insights_raw_queries

boolean

required

Whether raw SQL queries are collected

plan

string

required

The database plan

insights_enabled

boolean

required

True if query insights is enabled for the database

production_branch_web_console

boolean

required

Whether web console is enabled for production branches

migration_table_name

string

required

Table name to use for copying schema migration data

migration_framework

string

required

Framework used for applying migrations

created_at

string

required

When the database was created

updated_at

string

required

When the database was last updated

schema_last_updated_at

string

required

When the default branch schema was last changed.

kind

enum<string>

required

The kind of database

Available options:

mysql,

postgresql

Update database throttler configurations

Update database settings

Introduction

Webhooks in PlanetScale

Authentication

PlanetScale API

Get a database

Authorization

Authorizations

Path Parameters

Response