Update Preview Policy
curl --request PUT \
--url https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"sourceEnvironment": "<string>",
"sourceDatabaseId": "<string>",
"allowProductionData": true,
"expiresInDays": 123,
"deleteOnPreviewClose": true
}
'import requests
url = "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy"
payload = {
"enabled": True,
"sourceEnvironment": "<string>",
"sourceDatabaseId": "<string>",
"allowProductionData": True,
"expiresInDays": 123,
"deleteOnPreviewClose": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
sourceEnvironment: '<string>',
sourceDatabaseId: '<string>',
allowProductionData: true,
expiresInDays: 123,
deleteOnPreviewClose: true
})
};
fetch('https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy', 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.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'sourceEnvironment' => '<string>',
'sourceDatabaseId' => '<string>',
'allowProductionData' => true,
'expiresInDays' => 123,
'deleteOnPreviewClose' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy"
payload := strings.NewReader("{\n \"enabled\": true,\n \"sourceEnvironment\": \"<string>\",\n \"sourceDatabaseId\": \"<string>\",\n \"allowProductionData\": true,\n \"expiresInDays\": 123,\n \"deleteOnPreviewClose\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"sourceEnvironment\": \"<string>\",\n \"sourceDatabaseId\": \"<string>\",\n \"allowProductionData\": true,\n \"expiresInDays\": 123,\n \"deleteOnPreviewClose\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"sourceEnvironment\": \"<string>\",\n \"sourceDatabaseId\": \"<string>\",\n \"allowProductionData\": true,\n \"expiresInDays\": 123,\n \"deleteOnPreviewClose\": true\n}"
response = http.request(request)
puts response.read_bodydatabaseBranches
Update Preview Policy
Explicitly opt a project into preview database branches and select the source environment/database. Production data requires allowProductionData=true from an owner.
PUT
/
v1
/
orgs
/
{orgId}
/
projects
/
{projectId}
/
database-branch-policy
Update Preview Policy
curl --request PUT \
--url https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"sourceEnvironment": "<string>",
"sourceDatabaseId": "<string>",
"allowProductionData": true,
"expiresInDays": 123,
"deleteOnPreviewClose": true
}
'import requests
url = "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy"
payload = {
"enabled": True,
"sourceEnvironment": "<string>",
"sourceDatabaseId": "<string>",
"allowProductionData": True,
"expiresInDays": 123,
"deleteOnPreviewClose": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
sourceEnvironment: '<string>',
sourceDatabaseId: '<string>',
allowProductionData: true,
expiresInDays: 123,
deleteOnPreviewClose: true
})
};
fetch('https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy', 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.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'sourceEnvironment' => '<string>',
'sourceDatabaseId' => '<string>',
'allowProductionData' => true,
'expiresInDays' => 123,
'deleteOnPreviewClose' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy"
payload := strings.NewReader("{\n \"enabled\": true,\n \"sourceEnvironment\": \"<string>\",\n \"sourceDatabaseId\": \"<string>\",\n \"allowProductionData\": true,\n \"expiresInDays\": 123,\n \"deleteOnPreviewClose\": true\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"sourceEnvironment\": \"<string>\",\n \"sourceDatabaseId\": \"<string>\",\n \"allowProductionData\": true,\n \"expiresInDays\": 123,\n \"deleteOnPreviewClose\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/database-branch-policy")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"sourceEnvironment\": \"<string>\",\n \"sourceDatabaseId\": \"<string>\",\n \"allowProductionData\": true,\n \"expiresInDays\": 123,\n \"deleteOnPreviewClose\": true\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
apiKeysession
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The organization's id (UUID) or slug — either form is accepted.
The project's id (UUID) or slug — either form is accepted.
Body
application/json
Response
Preview database branch policy updated.
⌘I