Skip to main content
POST
/
api
/
v1
/
ci
/
{ci_config_id}
/
trigger
Trigger a PR/MR run
curl --request POST \
  --url https://app.datafold.com/api/v1/ci/{ci_config_id}/trigger \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_branch": "<string>",
  "base_sha": "<string>",
  "pr_branch": "<string>",
  "pr_number": 123,
  "pr_sha": "<string>"
}
'
import requests

url = "https://app.datafold.com/api/v1/ci/{ci_config_id}/trigger"

payload = {
"base_branch": "<string>",
"base_sha": "<string>",
"pr_branch": "<string>",
"pr_number": 123,
"pr_sha": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
base_branch: '<string>',
base_sha: '<string>',
pr_branch: '<string>',
pr_number: 123,
pr_sha: '<string>'
})
};

fetch('https://app.datafold.com/api/v1/ci/{ci_config_id}/trigger', 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://app.datafold.com/api/v1/ci/{ci_config_id}/trigger",
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([
'base_branch' => '<string>',
'base_sha' => '<string>',
'pr_branch' => '<string>',
'pr_number' => 123,
'pr_sha' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://app.datafold.com/api/v1/ci/{ci_config_id}/trigger"

payload := strings.NewReader("{\n \"base_branch\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"pr_branch\": \"<string>\",\n \"pr_number\": 123,\n \"pr_sha\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<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://app.datafold.com/api/v1/ci/{ci_config_id}/trigger")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"base_branch\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"pr_branch\": \"<string>\",\n \"pr_number\": 123,\n \"pr_sha\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.datafold.com/api/v1/ci/{ci_config_id}/trigger")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"base_branch\": \"<string>\",\n \"base_sha\": \"<string>\",\n \"pr_branch\": \"<string>\",\n \"pr_number\": 123,\n \"pr_sha\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "ci_run_id": 123,
  "run_id": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}

Authorizations

Authorization
string
header
required

Use the 'Authorization' header with the format 'Key '

Path Parameters

ci_config_id
integer
required

Body

application/json
base_branch
string
required
base_sha
string
required
pr_branch
string
required
pr_number
integer
required
pr_sha
string
required

Response

Successful Response

ci_run_id
integer | null
run_id
integer | null