# PlanetScale

> Manage PlanetScale database branches, backups and deploy requests, and read organization and database metadata.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/planetscale

## Actions

### Create backup

Create backup. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Branch (`branch`, text, required): The name of the branch
- Name (`name`, text): Name for the backup
- Retention unit (`retention_unit`, text): Unit for the retention period of the backup. One of: `hour`, `day`, `week`, `month`, `year`.
- Retention value (`retention_value`, number): Value between `1` and `1000` for the retention period of the backup (i.e retention_value `6` and retention_unit `hour` means 6 hours)
- Emergency (`emergency`, true/false): Whether the backup is an immediate backup that may affect database performance. Emergency backups are only supported for PostgreSQL databases.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "actor": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "backup_policy": {
      "created_at": "example",
      "display_name": "example",
      "frequency_unit": "example",
      "frequency_value": 1,
      "id": "example",
      "last_ran_at": "example",
      "name": "example",
      "next_run_at": "example",
      "required": false,
      "retention_unit": "example",
      "retention_value": 1,
      "schedule_day": 1,
      "schedule_time": "example",
      "schedule_week": 1,
      "target": "production",
      "updated_at": "example"
    },
    "completed_at": "example",
    "created_at": "example",
    "database_branch": {
      "created_at": "example",
      "deleted_at": "example",
      "id": "example",
      "name": "example",
      "updated_at": "example"
    },
    "deleted_at": "example",
    "estimated_storage_cost": 1.0,
    "expires_at": "example",
    "id": "example",
    "name": "example",
    "protected": false,
    "pvc_size": 1,
    "required": false,
    "restored_branches": [],
    "schema_snapshot": {
      "created_at": "example",
      "id": "example",
      "linted_at": "example",
      "name": "example",
      "updated_at": "example",
      "url": "example"
    },
    "size": 1,
    "started_at": "example",
    "state": "pending",
    "uncompressed_size": 1,
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create branch

Create branch. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Name (`name`, text, required): The name of the branch to create
- Deletion protected (`deletion_protected`, true/false): Whether deletion protection is enabled for the branch
- Parent branch (`parent_branch`, text): The name of the parent branch. Defaults to the database's default branch if not provided.
- Backup ID (`backup_id`, text): 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.
- Region (`region`, text): The region to create the branch in. If not provided, the branch will be created in the default region for its database.
- Restore point (`restore_point`, text): Restore from a point-in-time recovery timestamp (e.g. 2023-01-01T00:00:00Z). Available only for PostgreSQL databases.
- Replicas (`replicas`, number): 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.
- Seed data (`seed_data`, text): 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. One of: `last_successful_backup`.
- Cluster size (`cluster_size`, text): 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
- Keyspace cluster sizes (`keyspace_cluster_sizes`, list): 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.
- Configuration profile sizes (`configuration_profile_sizes`, list): 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.
- Router sizes (`router_sizes`, list): 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.
- Storage (`storage`, object): Storage.
- Major version (`major_version`, text): 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.
- Create database if missing (`create_database_if_missing`, true/false): Create a new database for the branch if the database does not exist. Defaults to false.
- Database kind (`database_kind`, text): The kind of branch to create. Required when create_database_if_missing is set. One of: `mysql`, `postgresql`, `neki`.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "actor": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "cluster_iops": 1,
    "cluster_name": "example",
    "created_at": "example",
    "deleted_at": "example",
    "deletion_protected": false,
    "direct_vtgate": false,
    "has_read_only_replicas": false,
    "has_replicas": false,
    "html_url": "example",
    "id": "example",
    "keyspace_count": 1,
    "kind": "mysql",
    "metal": false,
    "mysql_address": "example",
    "mysql_edge_address": "example",
    "name": "example",
    "parent_branch": "example",
    "private_edge_connectivity": false,
    "production": false,
    "ready": false,
    "region": {
      "current_default": false,
      "display_name": "example",
      "enabled": false,
      "id": "example",
      "location": "example",
      "mysql_supported": false,
      "neki_supported": false,
      "postgresql_supported": false,
      "provider": "example",
      "public_ip_addresses": [],
      "slug": "example"
    },
    "restore_checklist_completed_at": "example",
    "restored_from_branch": {
      "created_at": "example",
      "deleted_at": "example",
      "id": "example",
      "name": "example",
      "updated_at": "example"
    },
    "safe_migrations": false,
    "schema_last_updated_at": "example",
    "schema_ready": false,
    "shard_count": 1,
    "sharded": false,
    "stale_schema": false,
    "state": "pending",
    "updated_at": "example",
    "url": "example",
    "vtgate_autoscaling": false,
    "vtgate_count": 1,
    "vtgate_max_count": 1,
    "vtgate_name": "example",
    "vtgate_options": {},
    "vtgate_size": "example",
    "vtgate_target_cpu_utilization": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Create deploy request

Create deploy request. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the deploy request's organization
- Database (`database`, text, required): The name of the deploy request's database
- Branch (`branch`, text, required): The name of the branch the deploy request is created from
- Into branch (`into_branch`, text, required): The name of the branch the deploy request will be merged into
- Notes (`notes`, text): Notes about the deploy request
- Auto cutover (`auto_cutover`, true/false): 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.
- Auto delete branch (`auto_delete_branch`, true/false): Whether or not to enable auto_delete_branch for the deploy request. When enabled, will delete the branch once the DR successfully completes.
- Aggressive cutover (`aggressive_cutover`, true/false): Whether or not to enable aggressive cutover for this deploy request. When enabled, Vitess kills blocking queries and transactions on the first cutover attempt instead of retrying for up to an hour. Does not change the database setting.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "actor": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "approved": false,
    "branch": "example",
    "branch_deleted": false,
    "branch_deleted_at": "example",
    "branch_deleted_by": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "branch_id": "example",
    "closed_at": "example",
    "closed_by": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "created_at": "example",
    "deployed_at": "example",
    "deployment": {
      "actor": {
        "avatar_url": "example",
        "display_name": "example",
        "id": "example"
      },
      "aggressive_cutover": false,
      "auto_cutover": false,
      "auto_delete_branch": false,
      "cancelled_actor": {
        "avatar_url": "example",
        "display_name": "example",
        "id": "example"
      },
      "created_at": "example",
      "cutover_actor": {
        "avatar_url": "example",
        "display_name": "example",
        "id": "example"
      },
      "cutover_at": "example",
      "cutover_expiring": false,
      "deploy_check_errors": "example",
      "deploy_operation_summaries": [],
      "deploy_operations": [],
      "deploy_request_number": 1,
      "deployable": false,
      "deployment_revert_request": {},
      "finished_at": "example",
      "force_cutover_requested_at": "example",
      "id": "example",
      "instant_ddl": false,
      "instant_ddl_eligible": false,
      "into_branch": "example",
      "lint_errors": [],
      "locked_table_name": "example",
      "lookup_vindex_operations": [],
      "preceding_deployments": [],
      "queue_pause_reason": "example",
      "queue_paused": false,
      "queued_at": "example",
      "ready_to_cutover_at": "example",
      "retry_requested": false,
      "retry_requested_at": "example",
      "schema_last_updated_at": "example",
      "sequential_diff_dependencies": [],
      "started_at": "example",
      "state": "pending",
      "submitted_at": "example",
      "table_locked": false,
      "throttler_configurations": {},
      "updated_at": "example"
    },
    "deployment_state": "pending",
    "html_body": "example",
    "html_url": "example",
    "id": "example",
    "into_branch": "example",
    "into_branch_keyspace_count": 1,
    "into_branch_shard_count": 1,
    "into_branch_sharded": false,
    "notes": "example",
    "num_comments": 1,
    "number": 1,
    "state": "open",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Delete backup

Delete backup. Returns one response page; the connected account determines access.

**Inputs**

- ID (`id`, text, required): The ID of the backup
- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Branch (`branch`, text, required): The name of the branch

**Outputs**: API response.

- `data` (null): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}
```

### Delete branch

Delete branch. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Branch (`branch`, text, required): The name of the branch
- Delete descendants (`delete_descendants`, true/false): If true, recursively delete all descendant branches along with this branch

**Outputs**: API response.

- `data` (null): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}
```

### Get backup

Get backup. Returns one response page; the connected account determines access.

**Inputs**

- ID (`id`, text, required): The ID for the backup
- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Branch (`branch`, text, required): The name of the branch

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "actor": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "backup_policy": {
      "created_at": "example",
      "display_name": "example",
      "frequency_unit": "example",
      "frequency_value": 1,
      "id": "example",
      "last_ran_at": "example",
      "name": "example",
      "next_run_at": "example",
      "required": false,
      "retention_unit": "example",
      "retention_value": 1,
      "schedule_day": 1,
      "schedule_time": "example",
      "schedule_week": 1,
      "target": "production",
      "updated_at": "example"
    },
    "completed_at": "example",
    "created_at": "example",
    "database_branch": {
      "created_at": "example",
      "deleted_at": "example",
      "id": "example",
      "name": "example",
      "updated_at": "example"
    },
    "deleted_at": "example",
    "estimated_storage_cost": 1.0,
    "expires_at": "example",
    "id": "example",
    "name": "example",
    "protected": false,
    "pvc_size": 1,
    "required": false,
    "restored_branches": [],
    "schema_snapshot": {
      "created_at": "example",
      "id": "example",
      "linted_at": "example",
      "name": "example",
      "updated_at": "example",
      "url": "example"
    },
    "size": 1,
    "started_at": "example",
    "state": "pending",
    "uncompressed_size": 1,
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get backup policy

Get backup policy. Returns one response page; the connected account determines access.

**Inputs**

- ID (`id`, text, required): The ID of the backup policy
- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Database (`database`, text, required): Database name slug from `list_databases`. Example: `app-db`.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "created_at": "example",
    "display_name": "example",
    "frequency_unit": "example",
    "frequency_value": 1,
    "id": "example",
    "last_ran_at": "example",
    "name": "example",
    "next_run_at": "example",
    "required": false,
    "retention_unit": "example",
    "retention_value": 1,
    "schedule_day": 1,
    "schedule_time": "example",
    "schedule_week": 1,
    "target": "production",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get branch

Get branch. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Database (`database`, text, required): Database name slug from `list_databases`. Example: `app-db`.
- Branch (`branch`, text, required): Branch name from `list_branches`. Example: `main`.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "actor": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "cluster_iops": 1,
    "cluster_name": "example",
    "created_at": "example",
    "deleted_at": "example",
    "deletion_protected": false,
    "direct_vtgate": false,
    "has_read_only_replicas": false,
    "has_replicas": false,
    "html_url": "example",
    "id": "example",
    "keyspace_count": 1,
    "kind": "mysql",
    "metal": false,
    "mysql_address": "example",
    "mysql_edge_address": "example",
    "name": "example",
    "parent_branch": "example",
    "private_edge_connectivity": false,
    "production": false,
    "ready": false,
    "region": {
      "current_default": false,
      "display_name": "example",
      "enabled": false,
      "id": "example",
      "location": "example",
      "mysql_supported": false,
      "neki_supported": false,
      "postgresql_supported": false,
      "provider": "example",
      "public_ip_addresses": [],
      "slug": "example"
    },
    "restore_checklist_completed_at": "example",
    "restored_from_branch": {
      "created_at": "example",
      "deleted_at": "example",
      "id": "example",
      "name": "example",
      "updated_at": "example"
    },
    "safe_migrations": false,
    "schema_last_updated_at": "example",
    "schema_ready": false,
    "shard_count": 1,
    "sharded": false,
    "stale_schema": false,
    "state": "pending",
    "updated_at": "example",
    "url": "example",
    "vtgate_autoscaling": false,
    "vtgate_count": 1,
    "vtgate_max_count": 1,
    "vtgate_name": "example",
    "vtgate_options": {},
    "vtgate_size": "example",
    "vtgate_target_cpu_utilization": 1
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get branch schema

Get branch schema. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Branch (`branch`, text, required): The name of the branch
- Keyspace (`keyspace`, text): Return the schema for a single Vitess keyspace
- Namespace (`namespace`, text): Return the schema for a PostgreSQL catalog namespace in ` . ` format (e.g. public.schema1)

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get database

Get database. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Database (`database`, text, required): Database name slug from `list_databases`. Example: `app-db`.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "allow_data_branching": false,
    "at_backup_restore_branches_limit": false,
    "at_development_branch_usage_limit": false,
    "automatic_migrations": false,
    "branches_count": 1,
    "branches_url": "example",
    "config_change_queued": false,
    "config_changing": false,
    "created_at": "example",
    "default_branch": "example",
    "default_branch_read_only_regions_count": 1,
    "default_branch_shard_count": 1,
    "default_branch_table_count": 1,
    "deletion_protected": false,
    "development_branches_count": 1,
    "development_branches_limit": 1,
    "foreign_keys_enabled": false,
    "html_url": "example",
    "id": "example",
    "insights_enabled": false,
    "insights_raw_queries": false,
    "issues_count": 1,
    "kind": "mysql",
    "migration_framework": "example",
    "migration_table_name": "example",
    "multiple_admins_required_for_deletion": false,
    "name": "example",
    "open_schema_recommendations_count": 1,
    "plan": "example",
    "prefer_instant": false,
    "production_branch_web_console": false,
    "production_branches_count": 1,
    "ready": false,
    "region": {
      "current_default": false,
      "display_name": "example",
      "enabled": false,
      "id": "example",
      "location": "example",
      "mysql_supported": false,
      "neki_supported": false,
      "postgresql_supported": false,
      "provider": "example",
      "public_ip_addresses": [],
      "slug": "example"
    },
    "require_approval_for_deploy": false,
    "resize_queued": false,
    "resizing": false,
    "restrict_branch_region": false,
    "schema_last_updated_at": "example",
    "sharded": false,
    "state": "pending",
    "updated_at": "example",
    "url": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get deploy request

Get deploy request. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the deploy request's organization
- Database (`database`, text, required): The name of the deploy request's database
- Number (`number`, number, required): The number of the deploy request

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "actor": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "approved": false,
    "branch": "example",
    "branch_deleted": false,
    "branch_deleted_at": "example",
    "branch_deleted_by": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "branch_id": "example",
    "closed_at": "example",
    "closed_by": {
      "avatar_url": "example",
      "display_name": "example",
      "id": "example"
    },
    "created_at": "example",
    "deployed_at": "example",
    "deployment": {
      "actor": {
        "avatar_url": "example",
        "display_name": "example",
        "id": "example"
      },
      "aggressive_cutover": false,
      "auto_cutover": false,
      "auto_delete_branch": false,
      "cancelled_actor": {
        "avatar_url": "example",
        "display_name": "example",
        "id": "example"
      },
      "created_at": "example",
      "cutover_actor": {
        "avatar_url": "example",
        "display_name": "example",
        "id": "example"
      },
      "cutover_at": "example",
      "cutover_expiring": false,
      "deploy_check_errors": "example",
      "deploy_operation_summaries": [],
      "deploy_operations": [],
      "deploy_request_number": 1,
      "deployable": false,
      "deployment_revert_request": {},
      "finished_at": "example",
      "force_cutover_requested_at": "example",
      "id": "example",
      "instant_ddl": false,
      "instant_ddl_eligible": false,
      "into_branch": "example",
      "lint_errors": [],
      "locked_table_name": "example",
      "lookup_vindex_operations": [],
      "preceding_deployments": [],
      "queue_pause_reason": "example",
      "queue_paused": false,
      "queued_at": "example",
      "ready_to_cutover_at": "example",
      "retry_requested": false,
      "retry_requested_at": "example",
      "schema_last_updated_at": "example",
      "sequential_diff_dependencies": [],
      "started_at": "example",
      "state": "pending",
      "submitted_at": "example",
      "table_locked": false,
      "throttler_configurations": {},
      "updated_at": "example"
    },
    "deployment_state": "pending",
    "html_body": "example",
    "html_url": "example",
    "id": "example",
    "into_branch": "example",
    "into_branch_keyspace_count": 1,
    "into_branch_shard_count": 1,
    "into_branch_sharded": false,
    "notes": "example",
    "num_comments": 1,
    "number": 1,
    "state": "open",
    "updated_at": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Get organization

Get organization. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "allow_llm_usage": false,
    "billing_email": "example",
    "created_at": "example",
    "database_count": 1,
    "features": {},
    "has_card": false,
    "has_past_due_invoices": false,
    "id": "example",
    "idp_managed_roles": false,
    "invoice_budget_amount": "example",
    "keyspace_shard_limit": 1,
    "llm_usage_blocked": false,
    "managed_tenancy": false,
    "mcp_access_level": "example",
    "name": "example",
    "neki_router_replicas_per_cell_limit": 1,
    "payment_info_required": false,
    "plan": "example",
    "single_tenancy": false,
    "sso": false,
    "sso_directory": false,
    "sso_portal_url": "example",
    "updated_at": "example",
    "valid_billing_info": false
  },
  "has_more": false,
  "next_cursor": null
}
```

### List audit logs

List audit logs. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization
- Starting after (`starting_after`, text): If provided, returns results after the specified cursor
- Ending before (`ending_before`, text): If provided, returns results before the specified cursor
- Limit (`limit`, number): If provided, specifies the number of returned results (max 100)

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "cursor_end": "example",
    "cursor_start": "example",
    "data": [],
    "has_next": false,
    "has_prev": false,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List backup policies

List backup policies. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Database (`database`, text, required): Database name slug from `list_databases`. Example: `app-db`.
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List backups

List backups. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the branch belongs to
- Database (`database`, text, required): The name of the database the branch belongs to
- Branch (`branch`, text, required): The name of the branch
- All (`all`, true/false): Whether to include all backups, including deleted ones
- State (`state`, text): Filter backups by state. One of: `pending`, `running`, `success`, `failed`, `canceled`, `ignored`.
- Policy (`policy`, text): Filter backups by backup policy ID
- From date (`from_date`, text): Filter backups started after this date (e.g. 2023-01-01T00:00:00Z)
- To (`to`, text): Filter backups started before this date (e.g. 2023-01-31T23:59:59Z)
- Running at (`running_at`, text): Filter backups that are running during a specific time (e.g. 2023-01-01T00:00:00Z..2023-01-01T23:59:59Z)
- Production (`production`, true/false): Filter backups by production branch
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "total_count": 1,
    "total_pages": 1,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List branches

List branches. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Database (`database`, text, required): Database name slug from `list_databases`. Example: `app-db`.
- Q (`q`, text): Search branches by name
- Production (`production`, true/false): Filter branches by production status
- Safe migrations (`safe_migrations`, true/false): Filter branches by safe migrations (DDL protection)
- Order (`order`, text): Order branches by created_at time. One of: `asc`, `desc`.
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "total_count": 1,
    "total_pages": 1,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List cluster size skus

List cluster size skus. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Engine (`engine`, text): The database engine to filter by. Defaults to 'mysql'. One of: `mysql`, `postgresql`, `neki`.
- Architecture (`architecture`, text): Filter by CPU architecture. One of: `aarch64`, `x86_64`.
- Rates (`rates`, true/false): Whether to include pricing rates in the response. Defaults to false.
- Region (`region`, text): The region slug to get rates for. If not specified, uses the organization's default region.
- Database (`database`, text): The database name to resolve rates for. When specified, database-level custom rates take precedence over organization rates.
- External (`external`, true/false): When true, list cluster sizes for external keyspaces. Defaults to false.

**Outputs**: API response.

- `data` (list): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List database regions

List database regions. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Database (`database`, text, required): Database name slug from `list_databases`. Example: `app-db`.
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List databases

List databases. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): Organization name slug from `list_organizations`. Example: `acme`.
- Q (`q`, text): Search term to filter databases by name
- Database kind (`database_kind`, text): Filter databases by kind. One of: `mysql`, `postgresql`, `neki`.
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "total_count": 1,
    "total_pages": 1,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List deploy request reviews

List deploy request reviews. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the deploy request belongs to
- Database (`database`, text, required): The name of the database the deploy request belongs to
- Number (`number`, number, required): The number of the deploy request
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List deploy requests

List deploy requests. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the deploy request's organization
- Database (`database`, text, required): The name of the deploy request's database
- State (`state`, text): Filter by state of the deploy request (open, closed, deployed)
- Branch (`branch`, text): Filter by the name of the branch the deploy request is created from
- Into branch (`into_branch`, text): Filter by the name of the branch the deploy request will be merged into
- Deployed at (`deployed_at`, text): Filter deploy requests by the date they were deployed. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)
- Running at (`running_at`, text): Filter deploy requests by the date they were running. (e.g. 2023-01-01T00:00:00Z..2023-01-31T23:59:59Z)
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "total_count": 1,
    "total_pages": 1,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List organizations

List organizations. Returns one response page; the connected account determines access.

**Inputs**

- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List passwords

List passwords. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization the password belongs to
- Database (`database`, text, required): The name of the database the password belongs to
- Branch (`branch`, text, required): The name of the branch the password belongs to
- Read only region ID (`read_only_region_id`, text): A read-only region of the database branch. If present, the password results will be filtered to only those in the region
- Status (`status`, text): Filter passwords by status
- Q (`q`, text): Search passwords by name
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "total_count": 1,
    "total_pages": 1,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List service tokens

List service tokens. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "total_count": 1,
    "total_pages": 1,
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### List webhooks

List webhooks. Returns one response page; the connected account determines access.

**Inputs**

- Organization (`organization`, text, required): The name of the organization
- Database (`database`, text, required): The name of the database
- Page (`page`, number): If provided, specifies the page offset of returned results
- Per page (`per_page`, number): If provided, specifies the number of returned results

**Outputs**: API response.

- `data` (object): Data.
- `has_more` (true/false): Whether a continuation page is available.
- `next_cursor` (text): Continuation value, when supplied by the service.

**Example output**

```json
{
  "data": {
    "current_page": 1,
    "data": [],
    "next_page": 1,
    "next_page_url": "example",
    "per_page": 1,
    "prev_page": 1,
    "prev_page_url": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
