Link a ticket to a test case
curl --request POST \
--url https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"test_case_id": "01234567-0123-0123-0123-0123456789ab",
"external_ticket_id": "KAN-123",
"repo": {
"host": "github.com",
"owner": "my-github-org",
"name": "my-repo"
}
}
'import requests
url = "https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case"
payload = {
"test_case_id": "01234567-0123-0123-0123-0123456789ab",
"external_ticket_id": "KAN-123",
"repo": {
"host": "github.com",
"owner": "my-github-org",
"name": "my-repo"
}
}
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({
test_case_id: '01234567-0123-0123-0123-0123456789ab',
external_ticket_id: 'KAN-123',
repo: {host: 'github.com', owner: 'my-github-org', name: 'my-repo'}
})
};
fetch('https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case', 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/flaky-tests/link-ticket-to-test-case",
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([
'test_case_id' => '01234567-0123-0123-0123-0123456789ab',
'external_ticket_id' => 'KAN-123',
'repo' => [
'host' => 'github.com',
'owner' => 'my-github-org',
'name' => 'my-repo'
]
]),
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/flaky-tests/link-ticket-to-test-case"
payload := strings.NewReader("{\n \"test_case_id\": \"01234567-0123-0123-0123-0123456789ab\",\n \"external_ticket_id\": \"KAN-123\",\n \"repo\": {\n \"host\": \"github.com\",\n \"owner\": \"my-github-org\",\n \"name\": \"my-repo\"\n }\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/flaky-tests/link-ticket-to-test-case")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"test_case_id\": \"01234567-0123-0123-0123-0123456789ab\",\n \"external_ticket_id\": \"KAN-123\",\n \"repo\": {\n \"host\": \"github.com\",\n \"owner\": \"my-github-org\",\n \"name\": \"my-repo\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case")
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 \"test_case_id\": \"01234567-0123-0123-0123-0123456789ab\",\n \"external_ticket_id\": \"KAN-123\",\n \"repo\": {\n \"host\": \"github.com\",\n \"owner\": \"my-github-org\",\n \"name\": \"my-repo\"\n }\n}"
response = http.request(request)
puts response.read_body"<string>""<string>""<string>""<string>"Tests
Link a ticket to a test case
POST
/
flaky-tests
/
link-ticket-to-test-case
Link a ticket to a test case
curl --request POST \
--url https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '
{
"test_case_id": "01234567-0123-0123-0123-0123456789ab",
"external_ticket_id": "KAN-123",
"repo": {
"host": "github.com",
"owner": "my-github-org",
"name": "my-repo"
}
}
'import requests
url = "https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case"
payload = {
"test_case_id": "01234567-0123-0123-0123-0123456789ab",
"external_ticket_id": "KAN-123",
"repo": {
"host": "github.com",
"owner": "my-github-org",
"name": "my-repo"
}
}
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({
test_case_id: '01234567-0123-0123-0123-0123456789ab',
external_ticket_id: 'KAN-123',
repo: {host: 'github.com', owner: 'my-github-org', name: 'my-repo'}
})
};
fetch('https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case', 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/flaky-tests/link-ticket-to-test-case",
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([
'test_case_id' => '01234567-0123-0123-0123-0123456789ab',
'external_ticket_id' => 'KAN-123',
'repo' => [
'host' => 'github.com',
'owner' => 'my-github-org',
'name' => 'my-repo'
]
]),
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/flaky-tests/link-ticket-to-test-case"
payload := strings.NewReader("{\n \"test_case_id\": \"01234567-0123-0123-0123-0123456789ab\",\n \"external_ticket_id\": \"KAN-123\",\n \"repo\": {\n \"host\": \"github.com\",\n \"owner\": \"my-github-org\",\n \"name\": \"my-repo\"\n }\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/flaky-tests/link-ticket-to-test-case")
.header("x-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"test_case_id\": \"01234567-0123-0123-0123-0123456789ab\",\n \"external_ticket_id\": \"KAN-123\",\n \"repo\": {\n \"host\": \"github.com\",\n \"owner\": \"my-github-org\",\n \"name\": \"my-repo\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trunk.io/v1/flaky-tests/link-ticket-to-test-case")
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 \"test_case_id\": \"01234567-0123-0123-0123-0123456789ab\",\n \"external_ticket_id\": \"KAN-123\",\n \"repo\": {\n \"host\": \"github.com\",\n \"owner\": \"my-github-org\",\n \"name\": \"my-repo\"\n }\n}"
response = http.request(request)
puts response.read_body"<string>""<string>""<string>""<string>"Authorizations
Your organization API token. In the Trunk app, find it under Settings → Developer → API Keys, in the Organization API token (v1) section. v2 API keys don't work with the v1 API. The v1 API will be deprecated soon.
Body
application/json
The id of the test case. Should be a UUID.
Example:
"01234567-0123-0123-0123-0123456789ab"
The external identifier of the ticket. For Jira this is the ticket number prefixed by the Project Key. For Linear this is the ticket number prefixed by the Team Identifier
Examples:
"KAN-123"
"TRUNK-1234"
The repository to list tests for.
Show child attributes
Show child attributes
Response
OK
Was this page helpful?