Skip to main content
PlanetScale logo
  • Category: databases
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 245
  • Triggers: 0
  • Slug: PLANETSCALE
  • Version: 20261101_00

Tools

Slug: PLANETSCALE_ADD_ORGANIZATION_TEAM_MEMBERAdd a member to a team.

Input Parameters

string
required
The slug of the team
string
required
The ID of the organization member to add to the team
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_ASSIGN_SHARD_CONFIGURATION_PROFILE_SHARDSAssign shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
array
required
The IDs of the shards to assign
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_BULK_CREATE_SHARD_CONFIGURATION_PROFILE_SHARDSAdd shards to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

integer
required
The number of shards to add
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_ADMIN_CHANGE_REQUESTCancel a change request for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_BOUNCER_RESIZE_REQUESTCancel a bouncer resize request for a PostgreSQL database. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
The name of the bouncer
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_BRANCH_CHANGE_REQUESTCancel a branch resize change request. Vitess/MySQL databases only. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_DEPLOY_REQUESTCancel a queued deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_NEKI_CHANGE_REQUESTCancel a change request for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_ROUTER_CHANGE_REQUESTCancel a change request for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_SHARD_CONFIGURATION_PROFILE_CHANGE_REQUESTCancel a change request for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CANCEL_SIDECAR_CHANGE_REQUESTCancel a change request for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
ID from list_sidecars, or the configuration profile name.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CHECK_DEPLOY_REQUEST_STORAGEChecks whether the deploy request’s target branch cluster has enough storage to safely deploy the schema changes. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CLOSE_DEPLOY_REQUESTClose a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_COMPLETE_ERRORED_DEPLOYComplete an errored deploy. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_COMPLETE_GATED_DEPLOY_REQUESTComplete a gated deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_COMPLETE_REVERTComplete a revert. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CONFIGURE_ORGANIZATION_SSOReturn a URL for configuring the identity provider. Requires at least one verified domain.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_BACKUPCreate a backup.

Input Parameters

string
Name for the backup
string
required
The name of the branch
string
required
The name of the database the branch belongs to
boolean
Whether the backup is an immediate backup that may affect database performance. Emergency backups are only supported for PostgreSQL databases.
string
required
The name of the organization the branch belongs to
string ("hour" | "day" | "week" | "month" | "year")
Unit for the retention period of the backup
integer
Value between 1 and 1000 for the retention period of the backup (i.e retention_value 6 and retention_unit hour means 6 hours)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_BACKUP_POLICYCreate a backup policy.

Input Parameters

string
The name of the backup policy
string ("production" | "development")
Whether the policy is for production or development branches
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
integer
Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
string
required
Required time of day for the backup schedule in HH:MM format.
integer
Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
string ("hour" | "day" | "week" | "month")
The unit for the frequency of the backup policy
string ("hour" | "day" | "week" | "month" | "year")
The unit for the retention period of the backup policy
integer
A number value for the frequency of the backup policy
integer
A number value for the retention period of the backup policy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_BOUNCERCreate a bouncer. PostgreSQL databases only.

Input Parameters

string
The bouncer name
string
required
Branch name from list_branches. Example: main.
string ("primary" | "replica" | "replica_az_affinity")
Server type to target: primary, replica, or replica_az_affinity. Primary is the usual choice.
string
required
Database name slug from list_databases. Example: app-db.
string
The size SKU for the bouncer
string
required
Organization name slug from list_organizations. Example: acme.
integer
The number of replica servers per cell

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_BRANCHCreate a branch in a database, optionally creating the database if it is missing.

Input Parameters

string ("mysql" | "postgresql" | "neki")
The kind of branch to create. Required when create_database_if_missing is set.
string
required
The name of the branch to create
string
The region to create the branch in. If not provided, the branch will be created in the default region for its database.
object
PlanetScale body parameter storage.
string
required
The name of the database the branch belongs to
integer
For PostgreSQL backup restores and point-in-time recovery, the number of additional replicas from 0 to 8, subject to the target cluster size. 0 creates a single-node branch. If omitted, the target cluster size’s minimum is used.
string
If provided, restores the backup’s schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this.
string
If provided, restores the last successful backup’s schema and data to the new branch. Must have restore_production_branch_backup(s) or restore_backup(s) access to do this, in addition to Data Branching™ being enabled for the branch.
string
The database cluster size. Required if a backup_id is provided (unless keyspace_cluster_sizes covers every keyspace), optional otherwise. Options: PS_10, PS_20, PS_40, …, PS_2800
string
required
The name of the organization the branch belongs to
array
For Neki backup restores, per-router size and replica count. Each entry is { “name”: “default”, “router_size”: “NKR_20”, “replicas_per_cell”: 1 }. Omitted routers inherit the source size and replica count.
string
For PostgreSQL and Neki databases, the PostgreSQL major version to use for the branch. Defaults to the major version of the parent branch if it exists or the database’s default branch major version. Ignored for branches restored from backups.
string
The name of the parent branch. Defaults to the database’s default branch if not provided.
string
Restore from a point-in-time recovery timestamp (e.g. 2023-01-01T00:00:00Z). Available only for PostgreSQL databases.
boolean
Whether deletion protection is enabled for the branch
array
For MySQL backup restores, per-keyspace cluster sizes. Each entry is { “keyspace_name”: “main”, “cluster_size”: “PS_40” }. When provided, each restored keyspace must have a size here or via cluster_size.
boolean
Create a new database for the branch if the database does not exist. Defaults to false.
array
For Neki backup restores, per-configuration-profile cluster size and replica count. Each entry is { “name”: “default”, “cluster_size”: “PS_40”, “replicas”: 2 }. Omitted profiles inherit the source size and replica count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_BRANCH_LOG_SIGNATURECreates a signed token that can be used to access branch logs.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_DATABASECreate a database.

Input Parameters

string ("mysql" | "postgresql" | "neki")
The kind of database to create.
string
required
Name of the database
string
The region the database will be deployed in. If left blank, defaults to the organization’s default region.
object
PlanetScale body parameter storage.
integer
The number of replicas for the database. 0 for non-HA, 2+ for HA.
string
required
The database cluster size name (e.g., ‘PS_10’, ‘PS_80’). Use the ‘List available cluster sizes’ endpoint to get available options for your organization. /v1/organizations/:organization/cluster-size-skus
string
required
Organization name slug from list_organizations. Example: acme.
string
For PostgreSQL and Neki databases, the PostgreSQL major version to use for the database. Defaults to the latest available major version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_DATABASE_POSTGRES_CIDRCreate an IP restriction entry. PostgreSQL databases only.

Input Parameters

string
The PostgreSQL role to restrict access to. Leave empty or omit to allow access for all roles.
array
required
List of IPv4 CIDR ranges (e.g., [‘192.168.1.0/24’, ‘192.168.1.1/32’]). Must contain at least one valid IPv4 address or range.
string
The PostgreSQL schema to restrict access to. Leave empty or omit to allow access to all schemas.
string
required
The name of the database
string
An optional description for the IP restriction rule.
string
required
The name of the organization the database belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_DEPLOY_REQUESTCreate a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
Notes about the deploy request
string
required
The name of the branch the deploy request is created from
string
required
The name of the deploy request’s database
string
required
The name of the branch the deploy request will be merged into
boolean
Whether or not to enable auto_cutover for the deploy request. When enabled, will auto cutover to the new schema as soon as it is ready.
string
required
The name of the deploy request’s organization
boolean
Whether or not to enable auto_delete_branch for the deploy request. When enabled, will delete the branch once the DR successfully completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_INSIGHTS_AGENT_RUNCreate an Insights agent run.

Input Parameters

string ("review_slow_queries" | "implement_schema_recommendation")
required
The work the Insights agent should perform
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
array
The schema recommendation numbers to implement
array
The slow query patterns to review

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_ORGANIZATION_SSO_DOMAINEnable SSO if needed and return a URL for verifying an email domain.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_ORGANIZATION_TEAMCreate an organization team.

Input Parameters

string
required
The name of the team
string
A description of the team’s purpose
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_PASSWORDCreate a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
Time to live (in seconds) for the password. The password will be invalid when TTL has passed
string
Optional name of the password
string ("reader" | "writer" | "admin" | "readwriter")
The database role of the password (i.e. admin)
array
List of IP addresses or CIDR ranges that can use this password
string
required
The name of the branch the password belongs to
boolean
Whether the password is for a read replica
string
required
The name of the database the password belongs to
string
required
The name of the organization the password belongs to
boolean
Whether the password connects directly to a VTGate

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_PAYMENT_METHOD_SETUPCreate a hosted checkout session for adding or replacing an organization’s payment method.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_QUERY_PATTERNS_REPORTCreate a new query patterns report.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_READ_ONLY_REPLICACreate a read-only replica.

Input Parameters

string
required
The read-only replica name
string
required
Branch name from list_branches. Example: main.
string
required
The region slug for the read-only replica
object
PlanetScale body parameter storage.
string
required
Database name slug from list_databases. Example: app-db.
integer
The number of instances serving reads. Defaults to 1.
string
The cluster size SKU name. Defaults to the primary cluster size.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_ROLECreate role credentials. PostgreSQL databases only.

Input Parameters

integer
Time to live in seconds
string
The name of the role
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
array
Roles to inherit from
boolean
Whether the role should have the REPLICATION attribute
string
Require WHERE clause on DELETE statements
string
Require WHERE clause on UPDATE statements

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_ROUTERCreate a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router.
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The router size SKU, e.g. NKR_1. Defaults to the service’s default size.
string
required
Organization name slug from list_organizations. Example: acme.
integer
The number of router instances per availability zone. Defaults to the service’s default count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_SHARDAdd shards to a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_SHARD_CONFIGURATION_PROFILECreate a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The name of the shard configuration profile
string
required
Branch name from list_branches. Example: main.
object
PlanetScale body parameter storage.
string
required
Database name slug from list_databases. Example: app-db.
integer
The number of replicas for the shard configuration profile
string
The cluster size for the shard configuration profile
string
required
Organization name slug from list_organizations. Example: acme.
string
The PostgreSQL major version for the shard configuration profile
string
The PostgreSQL minor version for the shard configuration profile. Requires postgres_major_version when specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_SHARD_CONFIGURATION_PROFILE_SHARDAdd a shard to a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The display name of the shard
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_SWITCHOVERRequest a switchover for a PostgreSQL branch: a replica is promoted when available, while a single instance restarts and is unreachable during restart. The response method may initially be absent; only one switchover can run at a time, and a failed switchover has an unconfirmed outcome and may not be reversible.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The exact name of the replica returned by the branch’s Postgres infrastructure endpoint to promote. Omit to let the operator select an eligible replica. Only applies to branches with replicas.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_TRAFFIC_BUDGETCreate a traffic budget. PostgreSQL databases only.

Input Parameters

string ("enforce" | "warn" | "off")
The mode of the traffic budget
string
Name of the traffic budget
integer
The rate at which capacity refills, as a percentage of server resources (0-100). Unlimited when not set.
integer
The maximum capacity a single query can consume, measured as a percentage of seconds of full server usage (0-6000). Unlimited when not set.
array
Array of traffic rules to apply to the budget
string
required
Branch name from list_branches. Example: main.
integer
The maximum capacity that can be banked, measured as a percentage of seconds of full server usage (0-6000). Unlimited when not set.
string
required
Database name slug from list_databases. Example: app-db.
integer
The percentage of available worker processes this policy can use (0-100). Unlimited when not set.
string
required
Organization name slug from list_organizations. Example: acme.
integer
A percentage of capacity, burst, or concurrency thresholds to emit warnings for enforced budgets (0-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_TRAFFIC_RULECreate a traffic rule. PostgreSQL databases only.

Input Parameters

string ("match" | "each")
Kind of rule
array
Optional array of tags for this rule. Each rules take exactly one tag.
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The keyspace to apply a query pattern rule to
string
required
The ID of the traffic budget
string
Query pattern fingerprint to apply rule to
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_CREATE_WEBHOOKCreate a webhook.

Input Parameters

string
required
The URL the webhook will send events to
array
The events this webhook should subscribe to
boolean
Whether the webhook should be enabled
string
required
The name of the database
string
required
The name of the organization
string
The value to send in the Authorization header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_BACKUPDelete a backup. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the backup
string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_BACKUP_POLICYDelete a backup policy. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the backup policy
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_BOUNCERDelete a bouncer. PostgreSQL databases only. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
The name of the bouncer
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_BRANCHDelete a branch, optionally recursively deleting its descendant branches. This is destructive: confirm the target before calling.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to
boolean
If true, recursively delete all descendant branches along with this branch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_DATABASEDelete a database. This is destructive: confirm the target before calling.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_DATABASE_POSTGRES_CIDRDelete an IP restriction entry. PostgreSQL databases only. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the IP restriction entry
string
required
The name of the database
string
required
The name of the organization the database belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_ORGANIZATION_BILLING_PAYMENT_METHODDelete the current payment method for an organization. This is destructive: confirm the target before calling.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_ORGANIZATION_SSO_DOMAINDelete a verified or pending SSO domain. This is destructive: confirm the target before calling.

Input Parameters

string
required
The public ID of the organization domain
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_ORGANIZATION_TEAMDelete an organization team. This is destructive: confirm the target before calling.

Input Parameters

string
required
The slug of the team
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_PASSWORDDelete a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the password
string
required
The name of the branch the password belongs to
string
required
The name of the database the password belongs to
string
required
The name of the organization the password belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_QUERY_PATTERNS_REPORTDelete a query patterns report. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the query patterns report
string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_READ_ONLY_REPLICADelete a read-only replica. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
The name of the read-only replica

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_ROLEDelete role credentials. PostgreSQL databases only. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the role
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The optional role to reassign ownership to before dropping. Accepts the role’s ID, or its username with or without the branch ID suffix.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_ROUTERDelete a router from a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_SHARDRemove a shard from a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the shard
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_SHARD_CONFIGURATION_PROFILEDelete a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_SHARD_CONFIGURATION_PROFILE_SHARDRemove a shard from a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the shard
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_SHARD_CONFIGURATION_PROFILE_SHARDSRemove shards from a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This is destructive: confirm the target before calling.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
array
required
The IDs of the shards to remove
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_TRAFFIC_BUDGETDelete a traffic budget. PostgreSQL databases only. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the traffic budget
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_TRAFFIC_RULEDelete a traffic rule. PostgreSQL databases only. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the traffic rule
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
The ID of the traffic budget
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DELETE_WEBHOOKDelete a webhook. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the webhook
string
required
The name of the database
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DEMOTE_BRANCHDemotes a branch from production to development. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DISABLE_ORGANIZATION_SSODisable SSO and directory sync for the organization. This is destructive: confirm the target before calling.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DISABLE_ORGANIZATION_SSO_DIRECTORYDisable directory sync for the organization. Non-admin directory members are removed. This is destructive: confirm the target before calling.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DISABLE_SAFE_MIGRATIONSDisable safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This is destructive: confirm the target before calling.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_DISMISS_SCHEMA_RECOMMENDATIONDismiss a schema recommendation.

Input Parameters

integer
required
Schema recommendation sequence number. Example: 42.
string
The reason for dismissing the recommendation (max 500 characters)
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_ENABLE_ORGANIZATION_SSOEnable the SSO add-on for an organization, potentially returning a URL for verifying an email domain. This changes operational state and may not be safely reversible.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_ENABLE_ORGANIZATION_SSO_DIRECTORYReturn a URL for configuring directory sync. Requires SSO to be enabled.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_ENABLE_SAFE_MIGRATIONSEnable safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_FORCE_CUTOVER_DEPLOY_REQUESTEnable force cutover for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ADMINGet the admin for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ADMIN_CHANGE_REQUESTGet a change request for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BACKUPGet a backup.

Input Parameters

string
required
The ID for the backup
string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BACKUP_POLICYGet a backup policy.

Input Parameters

string
required
The ID of the backup policy
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BOUNCERGet a bouncer. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
The name of the bouncer
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCHGet a branch.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_ANOMALYRetrieve a branch anomaly.

Input Parameters

string
required
The anomaly ID
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_CHANGE_REQUESTGet a branch change request. PostgreSQL databases only.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_KEYSPACE_TABLE_METRICSRequest table storage metrics by keyspace for a database branch. The tool returns only a success indicator, not the metrics.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_METRICSRetrieve time-series metrics for a database branch. sh curl --get \ --header "Authorization: $PLANETSCALE_SERVICE_TOKEN" \ --data-urlencode "metrics=queries" \ --data-urlencode "period=15m" \ "https://api.planetscale.com/v1/organizations/acme/databases/app-db/branches/main/metrics" Each series contains its metric name, display label, identifying labels, and sampled [Unix timestamp, value] points: json { "type": "MetricSeries", "start_date": "2026-09-09T17:00:00Z", "end_date": "2026-09-09T17:15:00Z", "interval": 60, "series": [ { "type": "TimeSeries", "metric": "queries", "label": "Queries", "labels": { "tablet_type": "primary" }, "points": [[1788973200, 42.0]] } ] } .

Input Parameters

string
End of a custom time range as an ISO 8601 timestamp
string
Filter by pod
string
Start of a custom time range as an ISO 8601 timestamp
array
Filter by pods
string
Filter by Postgres role
string
Search terms to filter the metrics
string
Filter by shard
integer
Number of data points to return
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Named time period to retrieve. Defaults to 12h.
string
Filter by router
array
Metric names to retrieve. Pass as metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.
string
Filter by traffic rule ID
string
required
Database name slug from list_databases. Example: app-db.
string
Filter by keyspace
string
Filter by traffic budget ID
string
Filter by container
array
Filter by query pattern IDs
string
Filter by query fingerprint
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.
string
Filter by shard configuration profile name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_QUERYRetrieve a branch query.

Input Parameters

string
required
ID of an individual query execution returned as items[].id by GET_BRANCH_QUERY_ERROR. LIST_BRANCH_QUERIES returns query-summary IDs, which this endpoint does not accept.
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_QUERY_ERRORList queries for an error fingerprint.

Input Parameters

string
End time for filtering queries (ISO 8601 timestamp)
string
Start time for filtering queries (ISO 8601 timestamp)
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering queries
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
required
The error fingerprint
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_QUERY_METRICSGet time-series metrics for SQL queries.

Input Parameters

string
End of a custom time range as an ISO 8601 timestamp
string
Start of a custom time range as an ISO 8601 timestamp
string
Search terms to filter the metrics
integer
Number of data points to return
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Named time period to retrieve. Defaults to 12h.
array
Metric names to retrieve. Pass as metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.
string
Filter by traffic rule ID
string
required
Database name slug from list_databases. Example: app-db.
string
Keyspace for the query fingerprint
string
Filter by traffic budget ID
array
Query pattern IDs to retrieve metrics for
string
Filter by query fingerprint
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_QUERY_TAGRetrieve a query tag.

Input Parameters

string
End time for filtering tag values (ISO 8601 timestamp)
string
required
The tag name
string
Start time for filtering tag values (ISO 8601 timestamp)
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering tag values
string
required
Database name slug from list_databases. Example: app-db.
string
Filter by keyspace
string
Filter to tag values on queries with this fingerprint
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.
integer
Maximum number of values returned (1-100)
boolean
Only return literal tag values, excluding overflow and collapsed values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_RESIZE_REQUESTGet a branch resize request.

Input Parameters

string
required
The name of the branch
string
required
The ID of the branch resize request
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_SCHEMAGet a branch schema. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
Return the schema for a single Vitess keyspace
string
Return the schema for a PostgreSQL catalog namespace in <database>.<schema> format (e.g. public.schema1)
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_TABLE_METRICSRequest table storage metrics for a branch. The tool returns an operation success indicator rather than the metrics themselves.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_BRANCH_TAG_METRICSGet time-series metrics grouped by query tags.

Input Parameters

string
End of a custom time range as an ISO 8601 timestamp
string
Start of a custom time range as an ISO 8601 timestamp
string
Search terms to filter the metrics
integer
Number of data points to return
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Named time period to retrieve. Defaults to 12h.
array
Metric names to retrieve. Pass as metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.
string
Filter by traffic rule ID
string
required
Database name slug from list_databases. Example: app-db.
array
Tag sets to retrieve metrics for
string
Filter by traffic budget ID
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_CURRENT_USERGet the user associated with the current OAuth access token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DATABASEGet a database.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DATABASE_POSTGRES_CIDRGet an IP restriction entry. PostgreSQL databases only.

Input Parameters

string
required
The ID of the IP restriction entry
string
required
The name of the database
string
required
The name of the organization the database belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DATABASE_THROTTLERGet database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The name of the database that the throttled deploy requests belong to
string
required
The name of the organization that the throttled deploy requests belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DATA_TOPOLOGYGet the data topology for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DEFAULT_ROLEGet the default postgres role. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DEFAULT_SHARD_CONFIGURATION_PROFILEGet the default shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DEPLOYMENTGet the deployment for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DEPLOY_QUEUEThe deploy queue returns the current list of deploy requests in the order they will be deployed. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The name of the deploy request’s database
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DEPLOY_REQUESTGet a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_DEPLOY_REQUEST_THROTTLERGet deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_INSIGHTS_AGENT_RUNGet an Insights agent run.

Input Parameters

string
required
The Insights agent run ID
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_INSTANT_BRANCH_METRICSGet current metric values.

Input Parameters

string
Filter by pod
string
Filter by Postgres role
string
Filter by shard
string
required
Branch name from list_branches. Example: main.
array
Metric names to retrieve. Pass as metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other).
string
required
Database name slug from list_databases. Example: app-db.
string
Filter by container
string
required
Organization name slug from list_organizations. Example: acme.
string
Filter by shard configuration profile name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_INSTANT_TABLET_METRICSGet current tablet metrics.

Input Parameters

string
Filter by shard
string
required
Branch name from list_branches. Example: main.
array
Metric names to retrieve. Pass as metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other).
string
required
Database name slug from list_databases. Example: app-db.
string
Filter by keyspace
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_INVOICEGet an invoice.

Input Parameters

string
required
Invoice public ID from list_invoices. Example: aabb12123434.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_INVOICE_LINE_ITEMSGet the line items for an invoice.

Input Parameters

string
required
Invoice public ID from list_invoices. Example: aabb12123434.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_MAINTENANCE_SCHEDULEGet a maintenance schedule. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The ID of the maintenance schedule
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_NEKI_CHANGE_REQUESTGet a change request for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATIONGet an organization.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATION_BILLING_PAYMENT_METHODGet the current payment method for an organization.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATION_MEMBERSHIPGet a PlanetScale organization member by user ID or membership ID. Returns membership details, including the user’s information and organization role.

Input Parameters

string
required
User ID or membership ID from list_organization_members. PlanetScale documents the user ID, but the detail endpoint can return 404 for IDs present in the list; this action falls back to the list result.
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATION_SSOGet SSO add-on status, identity provider connection state, directory sync, and verified domains.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATION_SSO_DOMAINGet a registered SSO email domain and its verification state.

Input Parameters

string
required
The public ID of the organization domain
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATION_TEAMGet an organization team.

Input Parameters

string
required
The slug of the team
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ORGANIZATION_TEAM_MEMBERGet a team member.

Input Parameters

string
required
The ID of the team membership or the ID of the member
string
required
The slug of the team
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_PASSWORDGet a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The ID of the password
string
required
The name of the branch the password belongs to
string
required
The name of the database the password belongs to
string
required
The name of the organization the password belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_PAYMENT_METHOD_SETUPGet the state of a billing payment method setup.

Input Parameters

string
required
Billing payment method setup ID from create_payment_method_setup. Example: pmsetup_1234.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_QUERY_PATTERNS_REPORTDownload a finished query patterns report.

Input Parameters

string
required
The ID of the query patterns report
string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_QUERY_PATTERNS_REPORT_STATUSShow the status of a query patterns report.

Input Parameters

string
required
The ID of the query patterns report
string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_QUERY_STATISTICSRetrieve query statistics.

Input Parameters

string
End time for filtering query statistics (ISO 8601 timestamp)
string
Start time for filtering query statistics (ISO 8601 timestamp)
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering query statistics
string
required
Database name slug from list_databases. Example: app-db.
string
required
The keyspace to filter by
integer
If provided, specifies the number of returned results
string
required
The query fingerprint
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_QUERY_SUMMARYRetrieve a summary of query statistics.

Input Parameters

string
End time for filtering query statistics (ISO 8601 timestamp)
string
Start time for filtering query statistics (ISO 8601 timestamp)
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering query statistics
string
required
Database name slug from list_databases. Example: app-db.
string
required
The keyspace to filter by
string
required
The query fingerprint
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_READ_ONLY_REPLICAGet a read-only replica.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
The name of the read-only replica

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ROLEGet a role. PostgreSQL databases only.

Input Parameters

string
required
The ID of the role
string
Return libpq options that pin this Neki shard
string
required
Branch name from list_branches. Example: main.
string
Return connection details for this Neki router group
string
Return connection details for this bouncer
boolean
Return connection details for a replica
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
Return connection details for this read-only replica

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ROUTERGet a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_ROUTER_CHANGE_REQUESTGet a change request for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SCHEMA_RECOMMENDATIONGet a schema recommendation.

Input Parameters

integer
required
Schema recommendation sequence number. Example: 42.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SHARDGet a shard for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the shard
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SHARD_CONFIGURATION_PROFILEGet a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SHARD_CONFIGURATION_PROFILE_CHANGE_REQUESTGet a change request for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SHARD_CONFIGURATION_PROFILE_SHARDGet a shard in a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the shard
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SIDECARGet a sidecar for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
ID from list_sidecars, or the configuration profile name.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SIDECAR_CHANGE_REQUESTGet a change request for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the change request
string
required
Branch name from list_branches. Example: main.
string
required
ID from list_sidecars, or the configuration profile name.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_SWITCHOVERGet a switchover. PostgreSQL databases only.

Input Parameters

string
required
The ID of the switchover
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_TABLET_METRICSGet time-series tablet metrics.

Input Parameters

string
End of a custom time range as an ISO 8601 timestamp
string
Filter by pod
string
Start of a custom time range as an ISO 8601 timestamp
string
Filter by shard
integer
Number of data points to return
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Named time period to retrieve. Defaults to 12h.
array
Metric names to retrieve. Pass as metrics[]=name (repeat for multiple), metrics=name, or a comma-separated list (metrics=name,other). Time range is period (for example 15m) or ISO 8601 from/to.
string
required
Database name slug from list_databases. Example: app-db.
string
Filter by keyspace
string
Filter by workflow ID
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_TRAFFIC_BUDGETGet a traffic budget. PostgreSQL databases only.

Input Parameters

string
required
The ID of the traffic budget
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_GET_WEBHOOKGet a webhook.

Input Parameters

string
required
The ID of the webhook
string
required
The name of the database
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LINT_BRANCH_SCHEMALint a branch schema. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ADMIN_CHANGE_REQUESTSList change requests for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Filter change requests by named period
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
Filter change requests completed between two ISO 8601 timestamps
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ADMIN_PARAMETERSList parameters for a Neki admin. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ADMIN_SIZE_SKUSList admin size SKUs for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_AUDIT_LOGSList audit logs.

Input Parameters

integer
If provided, specifies the number of returned results (max 100)
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization
string
If provided, returns results before the specified cursor

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BACKUP_POLICIESList backup policies.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BACKUPSList backups.

Input Parameters

string
Filter backups started before this date (e.g. 2023-01-31T23:59:59Z)
boolean
Whether to include all backups, including deleted ones
string
Filter backups started after this date (e.g. 2023-01-01T00:00:00Z)
string ("pending" | "running" | "success" | "failed" | "canceled" | "ignored")
Filter backups by state
string
required
The name of the branch
string
Filter backups by backup policy ID
string
required
The name of the database the branch belongs to
integer
If provided, specifies the number of returned results
boolean
Filter backups by production branch
string
Filter backups that are running during a specific time (e.g. 2023-01-01T00:00:00Z..2023-01-01T23:59:59Z)
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BOUNCER_RESIZE_REQUESTSGet bouncer resize requests. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
The name of the bouncer
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BOUNCERSList bouncers. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_ANOMALIESList branch anomalies.

Input Parameters

string
End time for filtering anomalies (ISO 8601 timestamp)
string
Start time for filtering anomalies (ISO 8601 timestamp)
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering anomalies
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_BOUNCER_RESIZE_REQUESTSGet bouncer resize requests. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_CHANGE_REQUESTSGet branch change requests. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCHESList branches.

Input Parameters

string ("asc" | "desc")
Order branches by created_at time
string
Search branches by name
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
boolean
Filter branches by production status
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.
boolean
Filter branches by safe migrations (DDL protection)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_QUERIESList branch queries.

Input Parameters

string
End time for filtering query statistics (ISO 8601 timestamp)
string ("asc" | "desc")
Sort direction
string
Start time for filtering query statistics (ISO 8601 timestamp)
string ("keyspace" | "query" | "lastRun" | "count" | "errorCount" | "rowsRead" | "rowsAffected" | "rowsReturned" | "rowsReadPerReturned" | "rowsReadPerQuery" | "rowsReturnedPerQuery" | "rowsAffectedPerQuery" | "totalTime" | "cpuTime" | "ioTime" | "sumShardQueries" | "maxShardQueries" | "avgShardQueries" | "avgParallelWorkers" | "table" | "qualifiedTable" | "tableKeyspace" | "indexes" | "routingIndexes" | "p50Latency" | "p99Latency" | "maxLatency" | "percentTime" | "percentCpuTime" | "percentIoTime" | "egressBytes" | "egressBytesPerQuery" | "maxEgressBytes" | "ingressBytes" | "ingressBytesPerQuery" | "maxIngressBytes" | "blocksRead" | "blocksHit" | "blockCacheHitRatio" | "blocksDirtied" | "blocksWritten" | "trafficControlWarnings" | "trafficControlThrottled" | "trafficControlChecked" | "trafficControlBudgetsUsed")
Field to sort by
string ("SELECT" | "INSERT" | "UPDATE" | "DELETE")
Filter by statement type
string
Search query statistics by SQL pattern
string
required
Branch name from list_branches. Example: main.
array
Specific fields to include in the response
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering query statistics
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_QUERY_ERRORSList branch query errors.

Input Parameters

string
End time for filtering query errors (ISO 8601 timestamp)
string ("asc" | "desc")
Sort direction
string
Start time for filtering query errors (ISO 8601 timestamp)
string ("error" | "lastRun" | "count" | "totalTime" | "timePerQuery")
Field to sort by
string
Search query errors by error message
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering query errors
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_QUERY_TAGSList query tags.

Input Parameters

string
End time for filtering tags (ISO 8601 timestamp)
string
Start time for filtering tags (ISO 8601 timestamp)
string
Search tags by name
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering tags
string
required
Database name slug from list_databases. Example: app-db.
string
Filter by keyspace
integer
If provided, specifies the number of returned results
string
Filter to tags on queries with this fingerprint
string
Continuation cursor returned by the previous call; omit for the first page.
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.
integer
Maximum number of values returned per tag (1-100)
boolean
Only return literal tag values, excluding overflow and collapsed values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_QUERY_TAG_SUMMARIESList query statistics grouped by tag.

Input Parameters

string
End time for filtering query statistics (ISO 8601 timestamp)
string ("asc" | "desc")
Sort direction
string
Start time for filtering query statistics (ISO 8601 timestamp)
string ("dimensions" | "lastRun" | "count" | "errorCount" | "rowsRead" | "rowsAffected" | "rowsReturned" | "rowsReadPerReturned" | "rowsReadPerQuery" | "rowsReturnedPerQuery" | "rowsAffectedPerQuery" | "totalTime" | "cpuTime" | "ioTime" | "sumShardQueries" | "maxShardQueries" | "avgShardQueries" | "avgParallelWorkers" | "table" | "qualifiedTable" | "tableKeyspace" | "indexes" | "routingIndexes" | "p50Latency" | "p99Latency" | "maxLatency" | "percentTime" | "percentCpuTime" | "percentIoTime" | "egressBytes" | "egressBytesPerQuery" | "maxEgressBytes" | "ingressBytes" | "ingressBytesPerQuery" | "maxIngressBytes" | "blocksRead" | "blocksHit" | "blockCacheHitRatio" | "blocksDirtied" | "blocksWritten" | "trafficControlWarnings" | "trafficControlThrottled" | "trafficControlChecked" | "trafficControlBudgetsUsed")
Field to sort by
array
Tag ids returned by the tags list endpoint
string ("SELECT" | "INSERT" | "UPDATE" | "DELETE")
Filter by statement type
string
Search query statistics by SQL pattern
string
required
Branch name from list_branches. Example: main.
array
Specific fields to include in the response
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period for filtering query statistics
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string ("primary" | "replica" | "rdonly")
Filter by tablet type
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_BRANCH_RESIZE_REQUESTSGet branch resize requests.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_CLUSTER_SIZE_SKUSList available cluster sizes for an organization.

Input Parameters

boolean
Whether to include pricing rates in the response. Defaults to false.
string ("mysql" | "postgresql" | "neki")
The database engine to filter by. Defaults to ‘mysql’.
string
The region slug to get rates for. If not specified, uses the organization’s default region.
string
The database name to resolve rates for. When specified, database-level custom rates take precedence over organization rates.
boolean
When true, list cluster sizes for external keyspaces. Defaults to false.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_DATABASE_POSTGRES_CIDRSList IP restriction entries. PostgreSQL databases only.

Input Parameters

string
required
The name of the database
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the database belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_DATABASE_REGIONSList database regions.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_DATABASESList databases.

Input Parameters

string
Search term to filter databases by name
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_DEPLOY_OPERATIONSList deploy operations for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_DEPLOY_REQUEST_REVIEWSList deploy request reviews. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the database the deploy request belongs to
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the deploy request belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_DEPLOY_REQUESTSList deploy requests for a database. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
Filter by state of the deploy request (open, closed, deployed)
string
Filter by the name of the branch the deploy request is created from
string
required
The name of the deploy request’s database
integer
If provided, specifies the number of returned results
string
Filter deploy requests by the date they were running. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)
string
Filter deploy requests by the date they were deployed. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)
string
Filter by the name of the branch the deploy request will be merged into
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_EXTENSIONSList cluster extensions. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_GENERATED_QUERY_PATTERNS_REPORTSList generated query patterns reports.

Input Parameters

integer
If provided, specifies the number of returned results (max 100)
string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the branch belongs to
string
If provided, returns results before the specified cursor

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_INSIGHTS_AGENT_RUNSList Insights agent runs.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_INSIGHTS_AGENT_SCHEDULESList Insights Agent schedules.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_INVOICESGet the invoices for an organization.

Input Parameters

integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_MAINTENANCE_SCHEDULESList maintenance schedules. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_MAINTENANCE_WINDOWSList maintenance windows. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The ID of the maintenance schedule
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_NEKI_CHANGE_REQUESTSList change requests for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

array
Filter change requests by state
string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Filter change requests by named period
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Filter change requests by target ID. Requires target_types
string
Continuation cursor returned by the previous call; omit for the first page.
string
Filter change requests completed between two ISO 8601 timestamps
string
required
Organization name slug from list_organizations. Example: acme.
array
Filter change requests by target type. Must contain one or more of: NekiAdmin, NekiCluster, NekiConfigurationProfile, NekiRouter, or NekiSidecar

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ORGANIZATION_MEMBERSList organization members.

Input Parameters

string
Search term to filter members by name or email
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ORGANIZATIONSList organizations the OAuth-connected user has access to.

Input Parameters

integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ORGANIZATION_SSO_DOMAINSList email domains registered for organization SSO.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ORGANIZATION_TEAM_MEMBERSList team members.

Input Parameters

string
required
The slug of the team
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ORGANIZATION_TEAMSList teams in an organization.

Input Parameters

string
Search term to filter teams by name
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_PARAMETERSReturns the parameters for a branch. To update the parameters, use the “update_branch_change_request” endpoint. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_PASSWORDSList passwords. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
Search passwords by name
string
required
The name of the branch the password belongs to
string
Filter passwords by status
string
required
The name of the database the password belongs to
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization the password belongs to
string
A read-only region of the database branch. If present, the password results will be filtered to only those in the region

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_POSTGRES_VERSIONSList published Postgres versions available for the neki engine.

Input Parameters

string
required
The database engine to list Postgres versions for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_READ_ONLY_REGIONSList read-only regions for the database’s default branch.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_READ_ONLY_REPLICA_CHANGE_REQUESTSGet read-only replica change requests.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Filter change requests by named period
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
Filter change requests completed between two ISO 8601 timestamps
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_READ_ONLY_REPLICASList read-only replicas.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_REGIONS_FOR_ORGANIZATIONList regions for an organization.

Input Parameters

integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ROLESList roles. PostgreSQL databases only.

Input Parameters

string
Search roles by name or username
string
required
Branch name from list_branches. Example: main.
string
Filter roles by status
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ROUTER_CHANGE_REQUESTSList change requests for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Filter change requests by named period
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
Filter change requests completed between two ISO 8601 timestamps
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ROUTER_PARAMETERSList parameters for a Neki router. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ROUTERSList routers for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_ROUTER_SIZE_SKUSList router size SKUs for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SCHEMA_RECOMMENDATIONSList schema recommendations.

Input Parameters

string ("open" | "closed")
Filter by recommendation state
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SHARD_CONFIGURATION_PROFILE_CHANGE_REQUESTSList change requests for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Filter change requests by named period
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
Filter change requests completed between two ISO 8601 timestamps
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SHARD_CONFIGURATION_PROFILE_EXTENSIONSList extensions for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SHARD_CONFIGURATION_PROFILE_PARAMETERSList parameters for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SHARD_CONFIGURATION_PROFILESList shard configuration profiles for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SHARD_CONFIGURATION_PROFILE_SHARDSList shards for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
Search shards by name or display name
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SHARDSList shards for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
Search shards by name, display name, or configuration profile
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.
string
Exclude shards in this shard configuration profile

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SIDECAR_CHANGE_REQUESTSList change requests for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Filter change requests by named period
string
required
ID from list_sidecars, or the configuration profile name.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
Filter change requests completed between two ISO 8601 timestamps
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SIDECAR_PARAMETERSList parameters for a Neki sidecar. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
ID from list_sidecars, or the configuration profile name.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SIDECARSList sidecars for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_SWITCHOVERSList switchovers. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_TRAFFIC_BUDGETSList traffic budgets. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string ("15m" | "1h" | "3h" | "6h" | "12h" | "1d" | "2d" | "7d" | "8d")
Time period filter
string
required
Database name slug from list_databases. Example: app-db.
integer
If provided, specifies the number of returned results
string
Filter by creation date range (format: ‘start..end’)
string
Filter budgets by query fingerprint
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_TRAFFIC_BUDGETS_FOR_QUERYList traffic budgets affecting a query fingerprint. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
Optional keyspace filter
integer
If provided, specifies the number of returned results
string
required
The query fingerprint
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_LIST_WEBHOOKSList webhooks for a database.

Input Parameters

string
required
The name of the database
integer
If provided, specifies the number of returned results
string
Continuation cursor returned by the previous call; omit for the first page.
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_OAUTH_TOKEN_INFOInspect whether the current OAuth access token is active and return its scopes and expiry.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_PROMOTE_BRANCHPromotes a branch from development to production. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_QUEUE_DEPLOY_REQUESTQueue a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
boolean
Whether or not to deploy the request with instant DDL. Defaults to false.
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_REASSIGN_ROLE_OBJECTSReassign objects owned by one role to another role. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The ID of the role
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
The role to reassign ownership to. Accepts the role’s ID, or its username with or without the branch ID suffix.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_REMOVE_ORGANIZATION_MEMBERRemove a member from an organization, optionally deleting associated passwords and service tokens when removing another member. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the user
string
required
The name of the organization
boolean
Whether to delete all passwords associated with the member. Only available when removing other members (not yourself).
boolean
Whether to delete all service tokens associated with the member. Only available when removing other members (not yourself).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_REMOVE_ORGANIZATION_TEAM_MEMBERRemove a member from a team, optionally deleting the member’s passwords created through that team. This is destructive: confirm the target before calling.

Input Parameters

string
required
The ID of the team membership or the ID of the member to remove
string
required
The slug of the team
string
required
The name of the organization
boolean
Whether to delete the member’s passwords created through this team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RENEW_PASSWORDRenew a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The ID of the password
string
required
The name of the branch the password belongs to
string
required
The name of the database the password belongs to
string
required
The name of the organization the password belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RENEW_ROLERenew role expiration. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The ID of the role
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RESET_DEFAULT_ROLEReset default credentials. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RESET_ROLEReset a role’s password. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The ID of the role
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_REVIEW_DEPLOY_REQUESTReview a deploy request by either approving or commenting on the deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
Deploy request review comments
string ("commented" | "approved")
Whether the review is a comment or approval. Service tokens must have corresponding access (either approve_deploy_request or review_deploy_request)
integer
required
The number of the deploy request
string
required
The name of the database the deploy request belongs to
string
required
The name of the organization the deploy request belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RUN_BRANCH_MAINTENANCERun maintenance for a Postgres branch. PostgreSQL databases only. This changes operational state and may not be safely reversible.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
boolean
Whether to upgrade the branch to the latest PostgreSQL minor version during maintenance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RUN_SHARD_CONFIGURATION_PROFILE_MAINTENANCERun maintenance for a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This changes operational state and may not be safely reversible.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_RUN_SHARD_CONFIGURATION_PROFILES_MAINTENANCERun maintenance for selected Neki shard configuration profiles. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404. This changes operational state and may not be safely reversible.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
array
required
The names of the shard configuration profiles to maintain

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_SET_DEFAULT_SHARD_CONFIGURATION_PROFILESet the default shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
required
The name of the shard configuration profile to make the default

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_SKIP_REVERT_PERIODSkips the revert period for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources. This changes operational state and may not be safely reversible.

Input Parameters

integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_TEST_WEBHOOKSends a test event to the webhook. This changes operational state and may not be safely reversible.

Input Parameters

string
required
The ID of the webhook
string
required
The name of the database
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_ADMINUpdate the admin for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The admin size SKU, e.g. NKA_0.
object
Admin parameters nested by namespace (e.g., {“admin”: {“recovery-poll-interval”: ”10s”}})
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_AUTO_APPLYEnables or disabled the auto-apply setting for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

boolean
Whether or not to enable auto-apply for the deploy request
integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_AUTO_DELETE_BRANCHEnables or disabled the auto-delete branch setting for a deploy request. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

boolean
Whether or not to enable auto-delete branch for the deploy request
integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_BACKUPUpdate a backup’s protection from deletion.

Input Parameters

string
required
The ID of the backup
string
required
The name of the branch
string
required
The name of the database the branch belongs to
boolean
Whether the backup is protected from deletion or not
string
required
The name of the organization the branch belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_BACKUP_POLICYUpdate a backup policy.

Input Parameters

string
required
The ID of the backup policy
string
The name of the backup policy
string ("production" | "development")
Whether the policy is for production or development branches
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
integer
Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
string
The time of day that the backup is scheduled, in HH:MM format
integer
Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
string ("hour" | "day" | "week" | "month")
The unit for the frequency of the backup policy
string ("hour" | "day" | "week" | "month" | "year")
The unit for the retention period of the backup policy
integer
A number value for the frequency of the backup policy
integer
A number value for the retention period of the backup policy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_BOUNCER_RESIZE_REQUESTUpsert a bouncer resize request. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
The type of server the bouncer targets.
string
required
The name of the bouncer
string
required
Database name slug from list_databases. Example: app-db.
object
Bouncer configuration parameters nested by namespace (e.g., {“pgbouncer”: {“default_pool_size”: “100”}}). Use the ‘List cluster parameters’ endpoint to retrieve available parameters. Only parameters with namespace ‘pgbouncer’ can be updated.
string
The bouncer size SKU name (e.g., ‘PGB_5’, ‘PGB_10’, ‘PGB_20’, ‘PGB_40’, ‘PGB_80’, ‘PGB_160’). Defaults to ‘PGB_5’.
string
required
Organization name slug from list_organizations. Example: acme.
integer
The number of PgBouncers per availability zone. Defaults to 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_BRANCHUpdate a branch’s name or deletion protection.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
The name to update the branch
string
required
The name of the organization the branch belongs to
boolean
Whether deletion protection is enabled for the branch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_BRANCH_CHANGE_REQUESTUpsert a change request for cluster size, replicas, storage, or parameters. PostgreSQL databases only.

Input Parameters

string
required
Branch name from list_branches. Example: main.
object
PlanetScale body parameter storage.
string
required
Database name slug from list_databases. Example: app-db.
integer
The total number of replicas
object
Cluster configuration parameters nested by namespace (e.g., {“pgconf”: {“max_connections”: “200”}}). Use the ‘List cluster parameters’ endpoint to retrieve available parameters. Supported namespaces include ‘patroni’, ‘pgconf’, and ‘pgbouncer’.
string
The size of the cluster. Available sizes can be found using the ‘List cluster sizes’ endpoint.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_BRANCH_RESIZE_REQUESTUpsert a resize request.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
The size of the vtgate cluster: VTG_5, VTG_10,…
string
required
The name of the organization the branch belongs to
integer
The number of vtgates in an availability zone
integer
The maximum number of vtgates in an availability zone when autoscaling is enabled
boolean
If autoscaling is enabled for the vtgate cluster
integer
The target CPU utilization for the vtgate cluster when autoscaling is enabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_DATABASE_POSTGRES_CIDRUpdate an IP restriction entry. PostgreSQL databases only.

Input Parameters

string
required
The ID of the IP restriction entry
string
The PostgreSQL role to restrict access to. Leave empty to allow access for all roles.
array
List of IPv4 CIDR ranges (e.g., [‘192.168.1.0/24’, ‘192.168.1.1/32’]). Only provided fields will be updated.
string
The PostgreSQL schema to restrict access to. Leave empty to allow access to all schemas.
string
required
The name of the database
string
An optional description for the IP restriction rule. Pass an empty string to clear.
string
required
The name of the organization the database belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_DATABASE_SETTINGSUpdate database settings.

Input Parameters

string
required
Database name slug from list_databases. Example: app-db.
string
The name to update the database to
string
required
Organization name slug from list_organizations. Example: acme.
string
The default branch of the database
boolean
Whether deletion protection is enabled for the database
string
A migration framework to use on the database. (Vitess only)
boolean
Whether or not data branching is allowed on the database. (Vitess only)
boolean
Whether or not to copy migration data to new branches and in deploy requests. (Vitess only)
boolean
Whether or not full queries should be collected from the database
string
Name of table to use as migration table for the database. (Vitess only)
boolean
Whether or not to limit branch creation to the same region as the one selected during database creation.
boolean
Whether or not deploy requests must be approved by a database administrator other than the request creator
boolean
Whether or not foreign key constraints are allowed on the database. (Vitess only)
boolean
Whether or not the web console can be used on the production branch of the database

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_DATABASE_THROTTLERUpdate database throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
A throttler ratio between 0 and 95 that will apply to all keyspaces in the database. 0 effectively disables throttler, while 95 drastically slows down deploy request migrations
string
required
The name of the database that the throttled deploy requests belong to
string
required
The name of the organization that the throttled deploy requests belong to
array
If specifying throttler ratios per keyspace, an array of { “keyspace_name”: “mykeyspace”, “ratio”: 10 }, one for each eligible keyspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_DATA_TOPOLOGYSet the data topology for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
object
required
The data topology JSON to set for the branch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_DEPLOY_REQUEST_THROTTLERUpdate deploy request throttler configurations. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

integer
A throttler ratio between 0 and 95 that will apply to all keyspaces affected by the deploy request. 0 effectively disables throttler, while 95 drastically slows down migrations in the deploy request
integer
required
The number of the deploy request
string
required
The name of the deploy request’s database
string
required
The name of the deploy request’s organization
array
If specifying throttler ratios per keyspace, an array of { “keyspace_name”: “mykeyspace”, “ratio”: 10 }, one for each eligible keyspace

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_INSIGHTS_AGENT_SCHEDULEUpdate an Insights Agent schedule.

Input Parameters

string
required
Branch name from list_branches. Example: main.
boolean
Whether the schedule is enabled
string
required
Database name slug from list_databases. Example: app-db.
string ("review_slow_queries" | "implement_schema_recommendation")
required
The scheduled run type
string
The IANA time zone
integer
The weekday for weekly schedules
integer
The day of month for monthly schedules
string
required
Organization name slug from list_organizations. Example: acme.
string
The local time of day in HH:MM format
string ("day" | "week" | "month")
The cadence unit

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_ORGANIZATIONUpdate an organization’s billing email, identity-provider managed roles setting, or expected monthly invoice budget.

Input Parameters

string
required
Organization name slug from list_organizations. Example: acme.
string
The billing email for the organization
boolean
Whether or not the IdP provider is be responsible for managing roles in PlanetScale
integer
The expected monthly budget for the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_ORGANIZATION_MEMBERSHIPUpdate organization member role.

Input Parameters

string
required
The ID of the user
string
required
The role to assign to the member (e.g., ‘admin’, ‘member’). Note: Cannot update your own role. Roles managed by IdP cannot be updated via API.
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_ORGANIZATION_TEAMUpdate an organization team.

Input Parameters

string
The new name for the team
string
required
The slug of the team
string
The new description for the team
string
required
The name of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_PASSWORDUpdate a password. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The ID of the password
string
The name for the password
array
List of IP addresses or CIDR ranges that can use this password
string
required
The name of the branch the password belongs to
string
required
The name of the database the password belongs to
string
required
The name of the organization the password belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_READ_ONLY_REPLICAUpdate a read-only replica.

Input Parameters

string
required
Branch name from list_branches. Example: main.
object
PlanetScale body parameter storage.
string
required
Database name slug from list_databases. Example: app-db.
integer
The number of instances serving reads
object
Configuration parameters nested by namespace (e.g., {“pgconf”: {“max_connections”: “300”}}). Values must be greater than or equal to the primary’s.
string
The cluster size SKU name
string
required
Organization name slug from list_organizations. Example: acme.
string
required
The name of the read-only replica

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_ROLEUpdate a role’s name or query safety settings. PostgreSQL databases only.

Input Parameters

string
required
The ID of the role
string
The new name of the role
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.
string
Require WHERE clause on DELETE statements
string
Require WHERE clause on UPDATE statements

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_ROUTERUpdate a router for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
Name from list_routers.
string
required
Database name slug from list_databases. Example: app-db.
object
Router parameters nested by namespace (e.g., {“router”: {“replication-lag-tolerable-max”: “15m”}})
boolean
Whether the router scales horizontally within each cell
string
The new router size for the router
string
required
Organization name slug from list_organizations. Example: acme.
integer
The new number of replicas in each cell
integer
The maximum number of replicas in each cell when autoscaling
integer
The target average CPU utilization percentage when autoscaling

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_SAFE_MIGRATIONSUpdate safe migrations for a branch. Vitess/MySQL databases only; PlanetScale returns 405 for PostgreSQL resources.

Input Parameters

string
required
The name of the branch
string
required
The name of the database the branch belongs to
string
required
The name of the organization the branch belongs to
boolean
required
Whether safe migrations are enabled

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_SHARDSend an update request for a shard on a Neki branch using resource identifiers; the request accepts no shard properties to update. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the shard
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_SHARD_CONFIGURATION_PROFILEUpdate a shard configuration profile for a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
The new name for the shard configuration profile
string
required
Branch name from list_branches. Example: main.
object
PlanetScale body parameter storage.
string
required
Database name slug from list_databases. Example: app-db.
integer
The new number of replicas for the shard configuration profile
array
Extensions to enable. This replaces the current set; omit it to leave them unchanged.
object
Configuration profile parameters nested by namespace (e.g., {“pgconf”: {“max_connections”: “200”}}).
string
The new cluster size for the shard configuration profile
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.
string
The PostgreSQL major version for the shard configuration profile
string
The PostgreSQL minor version for the shard configuration profile. Requires postgres_major_version when specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_SHARD_CONFIGURATION_PROFILE_SHARDUpdate the display name of a shard in a Neki shard configuration profile. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
The ID of the shard
string
required
Branch name from list_branches. Example: main.
string
required
Database name slug from list_databases. Example: app-db.
string
The display name of the shard
string
required
Organization name slug from list_organizations. Example: acme.
string
required
Name from list_shard_configuration_profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_SIDECARUpdate parameters for a sidecar on a Neki branch. Sharded Neki PostgreSQL databases only; non-sharded branches may return 404.

Input Parameters

string
required
Branch name from list_branches. Example: main.
string
required
ID from list_sidecars, or the configuration profile name.
string
required
Database name slug from list_databases. Example: app-db.
object
Sidecar parameters nested by namespace (e.g., {“sidecar”: {“pool-capacity”: “100”}})
string
required
Organization name slug from list_organizations. Example: acme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_TRAFFIC_BUDGETUpdate a traffic budget. PostgreSQL databases only.

Input Parameters

string
required
The ID of the traffic budget
string ("enforce" | "warn" | "off")
The mode of the traffic budget
string
Name of the traffic budget
integer
The rate at which capacity refills, as a percentage of server resources (0-100). Unlimited when not set.
integer
The maximum capacity a single query can consume, measured as a percentage of seconds of full server usage (0-6000). Unlimited when not set.
array
Array of traffic rules to apply to the budget
string
required
Branch name from list_branches. Example: main.
integer
The maximum capacity that can be banked, measured as a percentage of seconds of full server usage (0-6000). Unlimited when not set.
string
required
Database name slug from list_databases. Example: app-db.
integer
The percentage of available worker processes this policy can use (0-100). Unlimited when not set.
string
required
Organization name slug from list_organizations. Example: acme.
integer
A percentage of capacity, burst, or concurrency thresholds to emit warnings for enforced budgets (0-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PLANETSCALE_UPDATE_WEBHOOKUpdate a webhook.

Input Parameters

string
required
The ID of the webhook
string
The URL the webhook will send events to
array
The events this webhook should subscribe to
boolean
Whether the webhook should be enabled
string
required
The name of the database
string
required
The name of the organization
string
The value to send in the Authorization header

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not