Databases

Restore database (destructive)

⚠️ 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.

post/v1/databases/{targetDatabaseId}/restore

Request

  • Base URL: https://api.prisma.io
  • URL: https://api.prisma.io/v1/databases/{targetDatabaseId}/restore
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://auth.prisma.io/authorize, token URL https://auth.prisma.io/token, scopes: workspace:admin, offline_access)
    • HTTP bearer

Path parameters

targetDatabaseIdstring required

Request body

Response

Database restore initiated. The database status will be "recovering" until the restore completes.

Changes

No recorded changes to this operation across all 1 revision of this API.