Create

Create

curl --request POST \
  --url https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "environment": "<string>",
  "region": "<string>",
  "sku": "<string>",
  "source": {
    "backupId": "<string>",
    "pointInTime": "2023-11-07T05:31:56Z"
  },
  "expiresInDays": 123,
  "deleteOnPreviewClose": true,
  "previewId": "<string>"
}
'

import requests

url = "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches"

payload = {
    "name": "<string>",
    "environment": "<string>",
    "region": "<string>",
    "sku": "<string>",
    "source": {
        "backupId": "<string>",
        "pointInTime": "2023-11-07T05:31:56Z"
    },
    "expiresInDays": 123,
    "deleteOnPreviewClose": True,
    "previewId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    environment: '<string>',
    region: '<string>',
    sku: '<string>',
    source: {backupId: '<string>', pointInTime: '2023-11-07T05:31:56Z'},
    expiresInDays: 123,
    deleteOnPreviewClose: true,
    previewId: '<string>'
  })
};

fetch('https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches', 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}/databases/{databaseId}/branches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'environment' => '<string>',
    'region' => '<string>',
    'sku' => '<string>',
    'source' => [
        'backupId' => '<string>',
        'pointInTime' => '2023-11-07T05:31:56Z'
    ],
    'expiresInDays' => 123,
    'deleteOnPreviewClose' => true,
    'previewId' => '<string>'
  ]),
  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}/databases/{databaseId}/branches"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"region\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"source\": {\n    \"backupId\": \"<string>\",\n    \"pointInTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"expiresInDays\": 123,\n  \"deleteOnPreviewClose\": true,\n  \"previewId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"region\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"source\": {\n    \"backupId\": \"<string>\",\n    \"pointInTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"expiresInDays\": 123,\n  \"deleteOnPreviewClose\": true,\n  \"previewId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"region\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"source\": {\n    \"backupId\": \"<string>\",\n    \"pointInTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"expiresInDays\": 123,\n  \"deleteOnPreviewClose\": true,\n  \"previewId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "sourceDatabaseId": "<string>",
  "databaseId": "<string>",
  "name": "<string>",
  "environment": "<string>",
  "source": {
    "backupId": "<string>",
    "pointInTime": "2023-11-07T05:31:56Z"
  },
  "progressPercent": 123,
  "hydrationMode": "full_copy",
  "hydrationProgressPercent": 123,
  "connectionReady": true,
  "fullyHydrated": true,
  "deleteOnPreviewClose": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

POST

orgs

{orgId}

projects

{projectId}

databases

{databaseId}

branches

Create

curl --request POST \
  --url https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "environment": "<string>",
  "region": "<string>",
  "sku": "<string>",
  "source": {
    "backupId": "<string>",
    "pointInTime": "2023-11-07T05:31:56Z"
  },
  "expiresInDays": 123,
  "deleteOnPreviewClose": true,
  "previewId": "<string>"
}
'

import requests

url = "https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches"

payload = {
    "name": "<string>",
    "environment": "<string>",
    "region": "<string>",
    "sku": "<string>",
    "source": {
        "backupId": "<string>",
        "pointInTime": "2023-11-07T05:31:56Z"
    },
    "expiresInDays": 123,
    "deleteOnPreviewClose": True,
    "previewId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    environment: '<string>',
    region: '<string>',
    sku: '<string>',
    source: {backupId: '<string>', pointInTime: '2023-11-07T05:31:56Z'},
    expiresInDays: 123,
    deleteOnPreviewClose: true,
    previewId: '<string>'
  })
};

fetch('https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches', 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}/databases/{databaseId}/branches",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'environment' => '<string>',
    'region' => '<string>',
    'sku' => '<string>',
    'source' => [
        'backupId' => '<string>',
        'pointInTime' => '2023-11-07T05:31:56Z'
    ],
    'expiresInDays' => 123,
    'deleteOnPreviewClose' => true,
    'previewId' => '<string>'
  ]),
  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}/databases/{databaseId}/branches"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"region\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"source\": {\n    \"backupId\": \"<string>\",\n    \"pointInTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"expiresInDays\": 123,\n  \"deleteOnPreviewClose\": true,\n  \"previewId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"region\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"source\": {\n    \"backupId\": \"<string>\",\n    \"pointInTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"expiresInDays\": 123,\n  \"deleteOnPreviewClose\": true,\n  \"previewId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.korve.dev/v1/orgs/{orgId}/projects/{projectId}/databases/{databaseId}/branches")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"environment\": \"<string>\",\n  \"region\": \"<string>\",\n  \"sku\": \"<string>\",\n  \"source\": {\n    \"backupId\": \"<string>\",\n    \"pointInTime\": \"2023-11-07T05:31:56Z\"\n  },\n  \"expiresInDays\": 123,\n  \"deleteOnPreviewClose\": true,\n  \"previewId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "sourceDatabaseId": "<string>",
  "databaseId": "<string>",
  "name": "<string>",
  "environment": "<string>",
  "source": {
    "backupId": "<string>",
    "pointInTime": "2023-11-07T05:31:56Z"
  },
  "progressPercent": 123,
  "hydrationMode": "full_copy",
  "hydrationProgressPercent": 123,
  "connectionReady": true,
  "fullyHydrated": true,
  "deleteOnPreviewClose": true,
  "expiresAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId

string

required

The organization's id (UUID) or slug — either form is accepted.

projectId

string

required

The project's id (UUID) or slug — either form is accepted.

databaseId

string

required

Body

application/json

name

string

required

Pattern: ^[a-z][a-z0-9-]{1,61}$

environment

string

required

Pattern: ^[a-z][a-z0-9-]{0,38}$

region

string

required

sku

string

required

source

object

required

Show child attributes

expiresInDays

integer | null

Defaults to seven days; null disables expiry.

deleteOnPreviewClose

boolean

previewId

string | null

Response

Branch hydration queued.

string

required

sourceDatabaseId

string

required

databaseId

string | null

required

name

string

required

Pattern: ^[a-z][a-z0-9-]{1,61}$

environment

string

required

Pattern: ^[a-z][a-z0-9-]{0,38}$

source

object

required

Show child attributes

status

enum<string>

required

Available options:

queued,

hydrating,

ready,

failed,

expired,

promoted

progressPercent

integer

required

hydrationMode

enum<string>

required

Launch implementation hydrates a full independent copy; it is not copy-on-write.

Available options:

full_copy

hydrationProgressPercent

integer

required

connectionReady

boolean

required

True only when the independent database safely accepts customer connections.

fullyHydrated

boolean

required

True only after every data block is copied and verified. Full-copy branches never report connectionReady before this is true.

deleteOnPreviewClose

boolean

required

expiresAt

string<date-time> | null

required

Defaults to seven days; null disables automatic expiry.

createdAt

string<date-time>

required

List Dismiss

Start

Core concepts

Agents

Build

Data and work

Operate

CLI reference

API reference

Authorizations

Path Parameters

Body

Response