Databases
Restore database
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}/restoreAuthorizationBearer <token>
OAuth2 authentication
In: header
Scope: workspace:admin, offline_access
Path Parameters
targetDatabaseId*string
Match
^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.prisma.io/v1/databases/string/restore" \ -H "Content-Type: application/json" \ -d '{ "source": { "type": "backup", "databaseId": "string", "backupId": "string" } }'{
"data": {
"id": "string",
"type": "database",
"url": "http://example.com",
"name": "string",
"status": "failure",
"createdAt": "2019-08-24T14:15:22Z",
"isDefault": true,
"defaultConnectionId": "string",
"connections": [
{
"id": "string",
"type": "connection",
"url": "http://example.com",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z",
"kind": "postgres",
"endpoints": {
"direct": {
"host": "string",
"port": 0
},
"pooled": {
"host": "string",
"port": 0
},
"accelerate": {
"host": "string",
"port": 0
}
},
"directConnection": {
"host": "string",
"pass": "string",
"user": "string"
},
"database": {
"id": "string",
"url": "http://example.com",
"name": "string"
}
}
],
"project": {
"id": "string",
"url": "http://example.com",
"name": "string"
},
"region": {
"id": "string",
"name": "string"
},
"source": {
"type": "backup",
"databaseId": "string",
"backupId": "string"
}
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"hint": "string"
}
}