Restore a backup
curl --request POST \
--url https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore"
headers = {"x-brimble-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-brimble-key': '<api-key>'}};
fetch('https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-brimble-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-brimble-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-brimble-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Backup restore started",
"data": {
"project_id": "6a81bed11470bfcd2a5dbcfa",
"backup_history_id": "6a81bed11470bfcd2a5dbcfa",
"user_id": "6a81bed11470bfcd2a5dbcfa",
"team": "6a81bed11470bfcd2a5dbcfa",
"status": "pending",
"object_key": "<string>",
"engine": "<string>",
"failure_reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa"
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Databases
Restore a backup
API key scope: project.update
Team role permission: project.update
POST
/
v1
/
projects
/
database
/
{projectId}
/
backups
/
{backupId}
/
restore
Restore a backup
curl --request POST \
--url https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore"
headers = {"x-brimble-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-brimble-key': '<api-key>'}};
fetch('https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-brimble-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-brimble-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/projects/database/{projectId}/backups/{backupId}/restore")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-brimble-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Backup restore started",
"data": {
"project_id": "6a81bed11470bfcd2a5dbcfa",
"backup_history_id": "6a81bed11470bfcd2a5dbcfa",
"user_id": "6a81bed11470bfcd2a5dbcfa",
"team": "6a81bed11470bfcd2a5dbcfa",
"status": "pending",
"object_key": "<string>",
"engine": "<string>",
"failure_reason": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa"
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Authorizations
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
Pattern:
^[a-fA-F0-9]{24}$Pattern:
^[a-fA-F0-9]{24}$Last modified on October 10, 2026
Was this page helpful?