Skip to main content
POST
/
api
/
projects
/
{projectId}
/
branches
/
{branchId}
/
revert
Revert commit
curl --request POST \
  --url https://api.example.com/api/projects/{projectId}/branches/{branchId}/revert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branchName": "<string>",
  "commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message": "<string>"
}
'
import requests

url = "https://api.example.com/api/projects/{projectId}/branches/{branchId}/revert"

payload = {
    "branchName": "<string>",
    "commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "message": "<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({
    branchName: '<string>',
    commitId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    message: '<string>'
  })
};

fetch('https://api.example.com/api/projects/{projectId}/branches/{branchId}/revert', 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.example.com/api/projects/{projectId}/branches/{branchId}/revert",
  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' => '<string>',
    'commitId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'message' => '<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.example.com/api/projects/{projectId}/branches/{branchId}/revert"

	payload := strings.NewReader("{\n  \"branchName\": \"<string>\",\n  \"commitId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"message\": \"<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.example.com/api/projects/{projectId}/branches/{branchId}/revert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"branchName\": \"<string>\",\n  \"commitId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"message\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/projects/{projectId}/branches/{branchId}/revert")

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  \"branchName\": \"<string>\",\n  \"commitId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "default": true,
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "baseCommitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "changeRequests": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "type": "<string>",
      "branchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project ID

branchId
required

Branch ID or "main" for the default branch

Body

application/json
branchName
string
required

Name for the new revert branch

commitId
string<uuid>
required

ID of the commit to revert to

message
string
required

Commit message for the revert

Minimum string length: 1

Response

200 - application/json

The newly created revert branch

The newly created revert branch

id
string<uuid>
required

Branch ID

name
string
required

Branch name

default
boolean
required

Whether this is the default (main) branch

projectId
string<uuid>
required

Project ID

baseCommitId
string<uuid> | null
required

Base commit ID

createdById
string<uuid> | null
required

ID of user who created the branch

createdAt
string<date-time>
required

Creation timestamp

updatedAt
string<date-time>
required

Last update timestamp

createdBy
object | null

User who created the branch

changeRequests
object[]

Pending change requests