Create a Branch
curl --request POST \
--url https://{projectHost}/collections/{collectionName}/branches \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"branchName": "candidate",
"source": {
"kind": "branch",
"name": "main"
}
}
'import requests
url = "https://{projectHost}/collections/{collectionName}/branches"
payload = {
"branchName": "candidate",
"source": {
"kind": "branch",
"name": "main"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({branchName: 'candidate', source: {kind: 'branch', name: 'main'}})
};
fetch('https://{projectHost}/collections/{collectionName}/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://{projectHost}/collections/{collectionName}/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([
'branchName' => 'candidate',
'source' => [
'kind' => 'branch',
'name' => 'main'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{projectHost}/collections/{collectionName}/branches"
payload := strings.NewReader("{\n \"branchName\": \"candidate\",\n \"source\": {\n \"kind\": \"branch\",\n \"name\": \"main\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://{projectHost}/collections/{collectionName}/branches")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"branchName\": \"candidate\",\n \"source\": {\n \"kind\": \"branch\",\n \"name\": \"main\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{projectHost}/collections/{collectionName}/branches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"branchName\": \"candidate\",\n \"source\": {\n \"kind\": \"branch\",\n \"name\": \"main\"\n }\n}"
response = http.request(request)
puts response.read_body{
"branch": {
"name": "candidate",
"parentBranch": {
"branchId": "main-branch-id",
"name": "main"
},
"createdAt": 1788336000000,
"headSnapshot": {
"snapshotId": "snapshot-id",
"snapshotCommittedAt": 1788335940000
},
"parentSnapshot": {
"snapshotId": "snapshot-id",
"snapshotCommittedAt": 1788335940000
}
}
}{
"message": "Invalid request"
}{
"message": "Authentication failed"
}{
"message": "Resource not found"
}{
"message": "Resource already exists"
}{
"message": "<string>"
}{
"message": "Too many requests"
}{
"message": "Internal server error"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Branches, tags & aliases
Create a branch
Create a writable branch from another branch’s committed state in the same collection; pending writes are not copied. Omit source to use main. Only a branch source is allowed; tag and alias sources return 400 BadRequest. Optional source.asOf selects a retained committed snapshot. An empty source can create an empty branch, with parentBranch still recording the source branch.
POST
/
collections
/
{collectionName}
/
branches
Create a Branch
curl --request POST \
--url https://{projectHost}/collections/{collectionName}/branches \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"branchName": "candidate",
"source": {
"kind": "branch",
"name": "main"
}
}
'import requests
url = "https://{projectHost}/collections/{collectionName}/branches"
payload = {
"branchName": "candidate",
"source": {
"kind": "branch",
"name": "main"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({branchName: 'candidate', source: {kind: 'branch', name: 'main'}})
};
fetch('https://{projectHost}/collections/{collectionName}/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://{projectHost}/collections/{collectionName}/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([
'branchName' => 'candidate',
'source' => [
'kind' => 'branch',
'name' => 'main'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{projectHost}/collections/{collectionName}/branches"
payload := strings.NewReader("{\n \"branchName\": \"candidate\",\n \"source\": {\n \"kind\": \"branch\",\n \"name\": \"main\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://{projectHost}/collections/{collectionName}/branches")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"branchName\": \"candidate\",\n \"source\": {\n \"kind\": \"branch\",\n \"name\": \"main\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{projectHost}/collections/{collectionName}/branches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"branchName\": \"candidate\",\n \"source\": {\n \"kind\": \"branch\",\n \"name\": \"main\"\n }\n}"
response = http.request(request)
puts response.read_body{
"branch": {
"name": "candidate",
"parentBranch": {
"branchId": "main-branch-id",
"name": "main"
},
"createdAt": 1788336000000,
"headSnapshot": {
"snapshotId": "snapshot-id",
"snapshotCommittedAt": 1788335940000
},
"parentSnapshot": {
"snapshotId": "snapshot-id",
"snapshotCommittedAt": 1788335940000
}
}
}{
"message": "Invalid request"
}{
"message": "Authentication failed"
}{
"message": "Resource not found"
}{
"message": "Resource already exists"
}{
"message": "<string>"
}{
"message": "Too many requests"
}{
"message": "Internal server error"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Project API Key.
Path Parameters
Collection name.
Body
application/json
Response
Branch created.
Show child attributes
Show child attributes
Was this page helpful?