Skip to main content
Prisma Documentation Docs

Search documentation

Type to search this documentation.

Endpoints

Delete database

REST API: Deletes the database with the given ID.

Get database

REST API: Returns the database with the given ID.

List databases

REST API: Returns all databases the token has access to. Optionally filter by project ID.

Get list of databases

REST API: Returns databases for the given project.

Update database

REST API: Updates the database with the given ID. logicalId cannot be combined with branchId or branchGitName in one request; move the database first, then set its logicalId.

Restore database (destructive)

REST API: Destructive operation — this immediately and irreversibly overwrites all data in the target database with the contents of the specified backup. Any data written since the backup was taken will be lost. Ensure you have a recent backup of the target database before proceeding. Replaces the data in an existing database from a backup. Connections and credentials are preserved — only the data layer is replaced.

Create database

REST API: Creates a new database in the specified project. logicalId cannot be combined with branchGitName; pass branchId instead.

Create database

REST API: Creates a new database for the given project.

Get list of backups

REST API: Returns backups for the specified database.

Get database usage metrics

REST API: Returns usage metrics for the specified database.

Get list of database connections

REST API: Returns all connections for the given database.

Create database connection string

REST API: Creates a new connection string for the given database.

Delete integration

REST API: Revokes the integration tokens by integration ID.

Revoke integration tokens

REST API: Revokes the integration tokens with the given client ID.

Get integration by ID

REST API: Returns a single integration by its ID.

Get list of integrations

REST API: Returns integrations filtered by workspace ID.

Get list of integrations

REST API: Returns integrations for the given workspace.

Delete project

REST API: Deletes the project with the given ID.

Get project

REST API: Returns the project with the given ID.

Get list of projects

REST API: Returns the list of projects the token has access to.

Update project

REST API: Updates the project with the given ID.

Transfer project

REST API: Transfer the project with the given ID to the new owner's workspace

Create project with a postgres database

REST API: Creates a new project with a postgres database.

Get workspace subscription

REST API: Returns subscription information for the workspace with the given ID.

Get workspace

REST API: Returns the workspace with the given ID.

Get list of workspaces

REST API: Returns the list of workspaces the current token can access.

Delete connection

REST API: Deletes the connection with the given ID.

Get connection

REST API: Returns the connection with the given ID.

List connections

REST API: Returns all connections the actor has access to, with optional database filter.

Rotate connection credentials

REST API: Generates new credentials for the connection with the given ID. Revocation of the previous credentials is best-effort.

Create connection

REST API: Creates a new connection for the specified database.

Get all regions

REST API: Returns all available regions across products. Optionally filter by product.

Get current authenticated principal

REST API: Returns the user, workspace, and credential represented by the current token.

Get Prisma Accelerate regions

REST API: Returns all available regions for Prisma Accelerate.

Get Prisma Postgres regions

REST API: Returns all available regions for Prisma Postgres.

Delete bucket key

REST API: Revokes and deletes the bucket key with the given ID.

Delete bucket

REST API: Permanently deletes the bucket with the given ID, all objects stored in it, and all its access keys. This action cannot be undone.

List bucket keys

REST API: Returns all access keys for the given bucket.

Get bucket

REST API: Returns the bucket with the given ID.

List buckets

REST API: Returns all object-store buckets the token has access to. Optionally filter by project ID.

Update bucket

REST API: Updates the display name, logical id, or branch of the bucket with the given ID. The display name is a label only: the provider bucket name, the objects, and the access keys do not change. logicalId cannot be combined with branchId or branchGitName in one request; move the bucket first, then set its logicalId.

Create bucket key

REST API: Creates a new access key for the given bucket. The secretAccessKey field is returned exactly once in this response and is never stored — copy it immediately.

Create bucket

REST API: Creates a new object-store bucket in the specified project.

Delete service token

REST API: Revokes the service token with the given ID by deleting it.

List service tokens

REST API: Returns the service tokens for the given workspace, newest first.

Create service token

REST API: Creates a new service token for the given workspace. The value field is returned exactly once in this response and is never stored — copy it immediately.

Poll an approval

REST API: Reports where an approval stands, so an agent holding an approval_required response can wait for the sponsor's decision and retry. Only the agent the approval belongs to can read it.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu