Restore database (destructive)

POST/v1/databases/{targetDatabaseId}/restoreRestore 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.

Parameters

targetDatabaseIdstringpathrequired

pattern ^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$

Request body

application/json

object

sourceobjectrequired

Show child attributes

backupIdstringrequired

ID of the backup to restore from

databaseIdstringrequired

ID of the database the backup belongs to

pattern ^(db_)?([cC][^\s-]{8,}|[a-z0-9]+)$

typestringrequired

const "backup"

Example request

{
  "source": {
    "backupId": "string",
    "databaseId": "string",
    "type": "backup"
  }
}

Responses

object

dataobjectrequired

Show child attributes

branchIdnull | stringrequired

connectionsarray of objectrequired

Show child attributes

Show array items

createdAtstring · date-timerequired

databaseobjectrequired

Show child attributes

idstringrequired

namestringrequired

urlstring · urirequired

directConnectionnull | object

Deprecated: use `endpoints.direct` instead.

Show child attributes

hoststringrequired

passstringrequired

userstringrequired

endpointsobjectrequired

Show child attributes

accelerateobject

Show child attributes

hoststringrequired

portnumberrequired

directobject

Show child attributes

hoststringrequired

portnumberrequired

pooledobject

Show child attributes

hoststringrequired

portnumberrequired

idstringrequired

pattern ^(con_)([cC][^\s-]{8,}|[a-z0-9]+)$

kindstringrequired

one of "postgres", "accelerate"

namestringrequired

typestringrequired

const "connection"

urlstring · urirequired

createdAtstring · date-timerequired

defaultConnectionIdnull | stringrequired

pattern ^(con_)([cC][^\s-]{8,}|[a-z0-9]+)$

idstringrequired

isDefaultbooleanrequired

logicalIdnull | stringrequired

namestringrequired

projectobjectrequired

Show child attributes

idstringrequired

namestringrequired

urlstring · urirequired

regionnull | objectrequired

Show child attributes

idstringrequired

namestringrequired

sourceobjectrequired

Show child attributes

backupIdstringrequired

databaseIdstringrequired

typestringrequired

const "backup"

statusstringrequired

one of "failure", "provisioning", "ready", "recovering"

typestringrequired

const "database"

urlstring · urirequired

Example response

{
  "data": {
    "branchId": "string",
    "connections": [
      {
        "createdAt": "2026-06-09T00:00:00Z",
        "database": {
          "id": "string",
          "name": "string",
          "url": "https://example.com"
        },
        "directConnection": {
          "host": "string",
          "pass": "string",
          "user": "string"
        },
        "endpoints": {
          "accelerate": {
            "host": "string",
            "port": 0
          },
          "direct": {
            "host": "string",
            "port": 0
          },
          "pooled": {
            "host": "string",
            "port": 0
          }
        },
        "id": "string",
        "kind": "accelerate",
        "name": "string",
        "type": "connection",
        "url": "https://example.com"
      }
    ],
    "createdAt": "2026-06-09T00:00:00Z",
    "defaultConnectionId": "string",
    "id": "string",
    "isDefault": true,
    "logicalId": "string",
    "name": "string",
    "project": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "region": {
      "id": "string",
      "name": "string"
    },
    "source": {
      "backupId": "string",
      "databaseId": "string",
      "type": "backup"
    },
    "status": "failure",
    "type": "database",
    "url": "https://example.com"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

object

errorobjectrequired

Show child attributes

codestringrequired

hintstring

messagestringrequired

Example response

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Examples

targetDatabaseIdrequiredpath parameter

curl -X POST 'https://api.prisma.io/v1/databases/string/restore' \
  -H 'Content-Type: application/json' \
  -d '{"source":{"backupId":"string","databaseId":"string","type":"backup"}}'

const response = await fetch('https://api.prisma.io/v1/databases/string/restore', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"source":{"backupId":"string","databaseId":"string","type":"backup"}}),
});
const data = await response.json();

const response = await fetch('https://api.prisma.io/v1/databases/string/restore', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"source\":{\"backupId\":\"string\",\"databaseId\":\"string\",\"type\":\"backup\"}}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.prisma.io/v1/databases/string/restore",
    headers={"Content-Type": "application/json"},
    data='{"source":{"backupId":"string","databaseId":"string","type":"backup"}}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"source":{"backupId":"string","databaseId":"string","type":"backup"}}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.prisma.io/v1/databases/string/restore", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.prisma.io/v1/databases/string/restore");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"source\":{\"backupId\":\"string\",\"databaseId\":\"string\",\"type\":\"backup\"}}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.prisma.io/v1/databases/string/restore"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"source\":{\"backupId\":\"string\",\"databaseId\":\"string\",\"type\":\"backup\"}}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.prisma.io/v1/databases/string/restore")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"source\":{\"backupId\":\"string\",\"databaseId\":\"string\",\"type\":\"backup\"}}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.prisma.io/v1/databases/string/restore");
request.Content = new StringContent("{\"source\":{\"backupId\":\"string\",\"databaseId\":\"string\",\"type\":\"backup\"}}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "data": {
    "branchId": "string",
    "connections": [
      {
        "createdAt": "2026-06-09T00:00:00Z",
        "database": {
          "id": "string",
          "name": "string",
          "url": "https://example.com"
        },
        "directConnection": {
          "host": "string",
          "pass": "string",
          "user": "string"
        },
        "endpoints": {
          "accelerate": {
            "host": "string",
            "port": 0
          },
          "direct": {
            "host": "string",
            "port": 0
          },
          "pooled": {
            "host": "string",
            "port": 0
          }
        },
        "id": "string",
        "kind": "accelerate",
        "name": "string",
        "type": "connection",
        "url": "https://example.com"
      }
    ],
    "createdAt": "2026-06-09T00:00:00Z",
    "defaultConnectionId": "string",
    "id": "string",
    "isDefault": true,
    "logicalId": "string",
    "name": "string",
    "project": {
      "id": "string",
      "name": "string",
      "url": "https://example.com"
    },
    "region": {
      "id": "string",
      "name": "string"
    },
    "source": {
      "backupId": "string",
      "databaseId": "string",
      "type": "backup"
    },
    "status": "failure",
    "type": "database",
    "url": "https://example.com"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "hint": "string",
    "message": "string"
  }
}

Search documentation

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets

Parameters

Request body

Responses

Projects

Databases

Databases Connections

Database Backups

Database Usage

Connections

Integrations

Service Tokens

Workspaces

Regions

Misc

[Experimental]

Agents

Buckets