Cancel a pull request in a merge queue.

POST /cancelPullRequest

Cancel a pull request in a merge queue.

cURL

curl --request POST \
  --url https://api.trunk.io/v1/cancelPullRequest \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "repo": {
    "host": "<string>",
    "owner": "<string>",
    "name": "<string>"
  },
  "pr": {
    "number": 2147483647
  },
  "targetBranch": "<string>"
}
'

import requests

url = "https://api.trunk.io/v1/cancelPullRequest"

payload = {
    "repo": {
        "host": "<string>",
        "owner": "<string>",
        "name": "<string>"
    },
    "pr": { "number": 2147483647 },
    "targetBranch": "<string>"
}
headers = {
    "x-api-token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    repo: {host: '<string>', owner: '<string>', name: '<string>'},
    pr: {number: 2147483647},
    targetBranch: '<string>'
  })
};

fetch('https://api.trunk.io/v1/cancelPullRequest', 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.trunk.io/v1/cancelPullRequest",
  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([
    'repo' => [
        'host' => '<string>',
        'owner' => '<string>',
        'name' => '<string>'
    ],
    'pr' => [
        'number' => 2147483647
    ],
    'targetBranch' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-token: <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://api.trunk.io/v1/cancelPullRequest"

	payload := strings.NewReader("{\n  \"repo\": {\n    \"host\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"pr\": {\n    \"number\": 2147483647\n  },\n  \"targetBranch\": \"<string>\"\n}")

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

	req.Header.Add("x-api-token", "<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://api.trunk.io/v1/cancelPullRequest")
  .header("x-api-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repo\": {\n    \"host\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"pr\": {\n    \"number\": 2147483647\n  },\n  \"targetBranch\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trunk.io/v1/cancelPullRequest")

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

request = Net::HTTP::Post.new(url)
request["x-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"repo\": {\n    \"host\": \"<string>\",\n    \"owner\": \"<string>\",\n    \"name\": \"<string>\"\n  },\n  \"pr\": {\n    \"number\": 2147483647\n  },\n  \"targetBranch\": \"<string>\"\n}"

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

400

"<string>"

"<string>"

"<string>"

"<string>"

Authorizations

x-api-token · string · header · required

Body

application/json

repo · object · required

Show child attributes

pr · object · required

Show child attributes

targetBranch · string · required

Response

200

application/json

OK