Reference

List Database Backups

View all available backups for your database, including their status, size, and whether they're ready to restore. This helps you monitor backup health and plan for data recovery needs.

Restore Database Backup

Restore a previous database backup to a new instance, allowing you to recover data or create copies of your database for testing and development purposes.

Create Database Connection

Establish a new database connection with automatically generated credentials and connection strings, enabling your application to securely access your database without manual configuration.

Delete Database Connection

Permanently removes a database connection and invalidates its access credentials, immediately preventing any applications from using that connection. Use this when you need to deactivate database access for security, cleanup, or migration purposes.

List Database Connections

Retrieve all connections associated with your Prisma database to view access details, creation dates, and connection metadata. This helps you monitor who and what has access to your database infrastructure.

Create Project Database

Set up a new PostgreSQL database for your Prisma project in your preferred region, automatically generating connection strings and API keys for immediate use.

Execute SQL Query

Run read-only SQL queries directly against your Prisma Postgres database to retrieve and analyze data without modifying your records.

List Project Databases

Retrieve all databases associated with your Prisma project to see their status, location, and configuration details. This helps you track and manage your project's data infrastructure in one place.

Delete Prisma Database

Permanently removes a Prisma database and all its associated data when it's no longer needed. Use this to clean up unused databases and free up resources.

Execute SQL Command

Run custom SQL commands to modify your database data and structure, such as inserting records, updating information, or creating new tables. This is useful when you need direct database control beyond standard queries.

Get Prisma Database

Fetch detailed information about a specific Prisma database including its current status, configuration, and deployment location. Use this to monitor database health, verify setup details, and manage your database infrastructure.

List Workspace Integrations

Retrieve all integrations connected to your Prisma workspace, including details about permissions and who set them up. Use this to monitor active connections and manage your workspace's connected apps.

Create Prisma Project

Create a new Prisma project with a managed PostgreSQL database in your workspace. This sets up everything you need to start building with a database, including connection strings and API keys.

Delete Prisma Project

Permanently remove a Prisma project and all its associated databases, environments, and data from your account. This destructive action cannot be reversed, so use it only when you're certain you no longer need the project.

Get Prisma Project

Retrieve detailed information about a specific Prisma project including its name, creation date, and workspace details. Use this to display project information, verify project existence, or pull data for project management dashboards.

List Prisma Projects

Fetch a paginated list of all your Prisma projects with their IDs, names, and workspace details to discover available projects and manage your portfolio.

Transfer Prisma Project

Move a Prisma project and all its databases to another user's workspace, transferring complete ownership and control. Use this when you need to hand off a project to a client, team member, or partner.

List Prisma Accelerate Regions

Retrieve all available geographic regions where you can deploy Prisma Accelerate's global database cache to reduce latency for your users. This helps you choose optimal locations based on where your customers are located.

List Prisma Postgres Regions

Retrieve all available geographic regions where you can deploy Prisma Postgres databases, including their current availability status. Use this to choose the best location for your database based on your users' locations and capacity needs.

Inspect Database Schema

Examine your database structure to understand all tables, columns, data types, and relationships at a glance. This helps you work with your data more effectively without needing to consult documentation or database tools separately.

Get Database Usage Metrics

Monitor your database's storage consumption and read/write operation counts to understand resource usage and optimize costs. This helps you track how much data your application is consuming and identify performance bottlenecks.

List Prisma Workspaces

Retrieve all Prisma workspaces you have access to, with pagination support for easy browsing and selection. Useful for discovering your available projects and workspaces in one view.