Create Snapshot
POST {{apiPath}}/version-control/branches/{{branchId}}/commit
The POST /version-control/branches/{{branchId}}/commit operation commits all uncommitted changes into a new snapshot. The operation places the snapshot at the head of the branch identified by {{branchId}}.
After committing your changes, you can create a deployment package from the commit.
Request Model
For property descriptions, refer to Branch manager data model
| Property | Type | Required |
|---|---|---|
|
String |
Required |
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/version-control/branches/{{branchId}}/commit' \
--header 'x-user-id: {{userId}}' \
--header 'Content-Type: application/json' \
--data '{
"message": "example-commit-message"
}'
var options = new RestClientOptions("{{apiPath}}/version-control/branches/{{branchId}}/commit")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("x-user-id", "{{userId}}");
request.AddHeader("Content-Type", "application/json");
var body = @"{" + "\n" +
@" ""message"": ""example-commit-message""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/version-control/branches/{{branchId}}/commit"
method := "POST"
payload := strings.NewReader(`{
"message": "example-commit-message"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("x-user-id", "{{userId}}")
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
POST /version-control/branches/{{branchId}}/commit HTTP/1.1
Host: {{apiPath}}
x-user-id: {{userId}}
Content-Type: application/json
{
"message": "example-commit-message"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"message\": \"example-commit-message\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/version-control/branches/{{branchId}}/commit")
.method("POST", body)
.addHeader("x-user-id", "{{userId}}")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/version-control/branches/{{branchId}}/commit",
"method": "POST",
"timeout": 0,
"headers": {
"x-user-id": "{{userId}}",
"Content-Type": "application/json"
},
"data": JSON.stringify({
"message": "example-commit-message"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/version-control/branches/{{branchId}}/commit',
'headers': {
'x-user-id': '{{userId}}',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"message": "example-commit-message"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/version-control/branches/{{branchId}}/commit"
payload = json.dumps({
"message": "example-commit-message"
})
headers = {
'x-user-id': '{{userId}}',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/version-control/branches/{{branchId}}/commit');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'x-user-id' => '{{userId}}',
'Content-Type' => 'application/json'
));
$request->setBody('{\n "message": "example-commit-message"\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/version-control/branches/{{branchId}}/commit")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["x-user-id"] = "{{userId}}"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
"message": "example-commit-message"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"message\": \"example-commit-message\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/version-control/branches/{{branchId}}/commit")!,timeoutInterval: Double.infinity)
request.addValue("{{userId}}", forHTTPHeaderField: "x-user-id")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
201 Created
{
"id": "8b5491c0-b49c-404c-8ca3-382744c976ad",
"parentId": "98ef14f6-ac2f-4cd4-b927-9ff2e1f6b56d",
"state": "COMMITTED",
"commitDetails": {
"userId": "admin",
"dateTime": "2025-03-06T00:43:48.477821Z",
"message": "example-commit-message"
},
"approvals": [],
"branchId": "e94d66f9-ea57-4a92-b4a1-eb0c26af26fa"
}