Skip to main content
GET
Get current metric values

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization
string
required

Organization name slug from list_organizations. Example: acme.

database
string
required

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

branch
string
required

Branch name from list_branches. Example: main.

Query Parameters

metrics
enum<string>[]

Metric names to retrieve

Available options:
planetscale_backup_fetch_percent,
planetscale_backup_restore_active,
planetscale_dedicated_pgbouncer_cpu_usage,
planetscale_dedicated_pgbouncer_current_client_connections,
planetscale_dedicated_pgbouncer_current_connections,
planetscale_dedicated_pgbouncer_current_server_connections,
planetscale_dedicated_pgbouncer_max_connections,
planetscale_dedicated_pgbouncer_memory_usage,
planetscale_pgbouncer_current_client_connections,
planetscale_pgbouncer_current_server_connections,
planetscale_pgbouncer_settings_max_client_conn,
planetscale_postgres_connection_state,
planetscale_postgres_settings_max_connections,
planetscale_volume_capacity_bytes,
planetscale_volume_disk_usage_bytes,
planetscale_volume_usage_percentage
role
string

Filter by Postgres role

shard
string

Filter by shard

container
string

Filter by container

pod
string

Filter by pod

Response

Returns current metrics

type
string

The metrics response type

branch
object

The branch these metrics belong to

metrics
string[]

The current metric values