Get quarantine status for a CI run

curl --request POST \
  --url https://api.trunk.io/v2/test-collections/{id}/quarantine-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": {
    "host": "github.com",
    "owner": "acme",
    "name": "web"
  },
  "testIdentifiers": [
    {
      "name": "renders the checkout total",
      "parentName": "CheckoutSuite",
      "id": "88e5353c-190c-5dce-9d06-0e66c3e062b1",
      "className": "CheckoutSuiteTest"
    }
  ]
}
'

import requests

url = "https://api.trunk.io/v2/test-collections/{id}/quarantine-status"

payload = {
    "repo": {
        "host": "github.com",
        "owner": "acme",
        "name": "web"
    },
    "testIdentifiers": [
        {
            "name": "renders the checkout total",
            "parentName": "CheckoutSuite",
            "id": "88e5353c-190c-5dce-9d06-0e66c3e062b1",
            "className": "CheckoutSuiteTest"
        }
    ]
}
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({
    repo: {host: 'github.com', owner: 'acme', name: 'web'},
    testIdentifiers: [
      {
        name: 'renders the checkout total',
        parentName: 'CheckoutSuite',
        id: '88e5353c-190c-5dce-9d06-0e66c3e062b1',
        className: 'CheckoutSuiteTest'
      }
    ]
  })
};

fetch('https://api.trunk.io/v2/test-collections/{id}/quarantine-status', 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/v2/test-collections/{id}/quarantine-status",
  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' => 'github.com',
        'owner' => 'acme',
        'name' => 'web'
    ],
    'testIdentifiers' => [
        [
                'name' => 'renders the checkout total',
                'parentName' => 'CheckoutSuite',
                'id' => '88e5353c-190c-5dce-9d06-0e66c3e062b1',
                'className' => 'CheckoutSuiteTest'
        ]
    ]
  ]),
  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.trunk.io/v2/test-collections/{id}/quarantine-status"

	payload := strings.NewReader("{\n  \"repo\": {\n    \"host\": \"github.com\",\n    \"owner\": \"acme\",\n    \"name\": \"web\"\n  },\n  \"testIdentifiers\": [\n    {\n      \"name\": \"renders the checkout total\",\n      \"parentName\": \"CheckoutSuite\",\n      \"id\": \"88e5353c-190c-5dce-9d06-0e66c3e062b1\",\n      \"className\": \"CheckoutSuiteTest\"\n    }\n  ]\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.trunk.io/v2/test-collections/{id}/quarantine-status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repo\": {\n    \"host\": \"github.com\",\n    \"owner\": \"acme\",\n    \"name\": \"web\"\n  },\n  \"testIdentifiers\": [\n    {\n      \"name\": \"renders the checkout total\",\n      \"parentName\": \"CheckoutSuite\",\n      \"id\": \"88e5353c-190c-5dce-9d06-0e66c3e062b1\",\n      \"className\": \"CheckoutSuiteTest\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trunk.io/v2/test-collections/{id}/quarantine-status")

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  \"repo\": {\n    \"host\": \"github.com\",\n    \"owner\": \"acme\",\n    \"name\": \"web\"\n  },\n  \"testIdentifiers\": [\n    {\n      \"name\": \"renders the checkout total\",\n      \"parentName\": \"CheckoutSuite\",\n      \"id\": \"88e5353c-190c-5dce-9d06-0e66c3e062b1\",\n      \"className\": \"CheckoutSuiteTest\"\n    }\n  ]\n}"

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

{
  "testCollectionUuid": "204b6c93-1c51-4e0f-a13c-e07b9bc60688",
  "repositoryId": "7a1f0e3d-2b4c-4d5e-8f90-123456789abc",
  "quarantineEnabled": true,
  "tests": [
    {
      "clientTestId": "88e5353c-190c-5dce-9d06-0e66c3e062b1",
      "testId": "bfeebcf4-72d1-887d-8bcd-788d0dec7f97",
      "quarantined": true
    }
  ]
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

POST

test-collections

{id}

quarantine-status

Get quarantine status for a CI run

curl --request POST \
  --url https://api.trunk.io/v2/test-collections/{id}/quarantine-status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repo": {
    "host": "github.com",
    "owner": "acme",
    "name": "web"
  },
  "testIdentifiers": [
    {
      "name": "renders the checkout total",
      "parentName": "CheckoutSuite",
      "id": "88e5353c-190c-5dce-9d06-0e66c3e062b1",
      "className": "CheckoutSuiteTest"
    }
  ]
}
'

import requests

url = "https://api.trunk.io/v2/test-collections/{id}/quarantine-status"

payload = {
    "repo": {
        "host": "github.com",
        "owner": "acme",
        "name": "web"
    },
    "testIdentifiers": [
        {
            "name": "renders the checkout total",
            "parentName": "CheckoutSuite",
            "id": "88e5353c-190c-5dce-9d06-0e66c3e062b1",
            "className": "CheckoutSuiteTest"
        }
    ]
}
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({
    repo: {host: 'github.com', owner: 'acme', name: 'web'},
    testIdentifiers: [
      {
        name: 'renders the checkout total',
        parentName: 'CheckoutSuite',
        id: '88e5353c-190c-5dce-9d06-0e66c3e062b1',
        className: 'CheckoutSuiteTest'
      }
    ]
  })
};

fetch('https://api.trunk.io/v2/test-collections/{id}/quarantine-status', 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/v2/test-collections/{id}/quarantine-status",
  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' => 'github.com',
        'owner' => 'acme',
        'name' => 'web'
    ],
    'testIdentifiers' => [
        [
                'name' => 'renders the checkout total',
                'parentName' => 'CheckoutSuite',
                'id' => '88e5353c-190c-5dce-9d06-0e66c3e062b1',
                'className' => 'CheckoutSuiteTest'
        ]
    ]
  ]),
  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.trunk.io/v2/test-collections/{id}/quarantine-status"

	payload := strings.NewReader("{\n  \"repo\": {\n    \"host\": \"github.com\",\n    \"owner\": \"acme\",\n    \"name\": \"web\"\n  },\n  \"testIdentifiers\": [\n    {\n      \"name\": \"renders the checkout total\",\n      \"parentName\": \"CheckoutSuite\",\n      \"id\": \"88e5353c-190c-5dce-9d06-0e66c3e062b1\",\n      \"className\": \"CheckoutSuiteTest\"\n    }\n  ]\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.trunk.io/v2/test-collections/{id}/quarantine-status")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repo\": {\n    \"host\": \"github.com\",\n    \"owner\": \"acme\",\n    \"name\": \"web\"\n  },\n  \"testIdentifiers\": [\n    {\n      \"name\": \"renders the checkout total\",\n      \"parentName\": \"CheckoutSuite\",\n      \"id\": \"88e5353c-190c-5dce-9d06-0e66c3e062b1\",\n      \"className\": \"CheckoutSuiteTest\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trunk.io/v2/test-collections/{id}/quarantine-status")

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  \"repo\": {\n    \"host\": \"github.com\",\n    \"owner\": \"acme\",\n    \"name\": \"web\"\n  },\n  \"testIdentifiers\": [\n    {\n      \"name\": \"renders the checkout total\",\n      \"parentName\": \"CheckoutSuite\",\n      \"id\": \"88e5353c-190c-5dce-9d06-0e66c3e062b1\",\n      \"className\": \"CheckoutSuiteTest\"\n    }\n  ]\n}"

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

{
  "testCollectionUuid": "204b6c93-1c51-4e0f-a13c-e07b9bc60688",
  "repositoryId": "7a1f0e3d-2b4c-4d5e-8f90-123456789abc",
  "quarantineEnabled": true,
  "tests": [
    {
      "clientTestId": "88e5353c-190c-5dce-9d06-0e66c3e062b1",
      "testId": "bfeebcf4-72d1-887d-8bcd-788d0dec7f97",
      "quarantined": true
    }
  ]
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

{
  "error": {
    "code": "MERGE_QUEUE_NOT_FOUND",
    "message": "No merge queue found with ID xK9mP2nQ"
  }
}

Authorizations

Authorization

string

header

required

An API key, sent as Authorization: Bearer <key>. An organization admin creates one in the Trunk app under Settings → Developer → API Keys and chooses the merge-queue permissions it holds; a key with none can read merge queues but change nothing. Those permissions scope merge queue only: every key can use the Flaky Tests and Dynamic CI endpoints, including their writes, whatever permissions it holds.

Path Parameters

string

required

The collection's id: 8 alphanumeric characters.

Pattern: ^[0-9A-Za-z]{8}$

Example:

"aB3xY9kQ"

Body

application/json

The repository and the tests to look up.

repo

object | null

required

The repository the tests ran in, as the CLI reads it from git. null for an upload made without a repository (--no-repo).

Show child attributes

testIdentifiers

object[]

The tests to report on, usually the run's failures. Each one gets an entry in tests, in this order.

Maximum array length: 2000

Show child attributes

Response

The collection's quarantine status

testCollectionUuid

string<uuid>

required

The collection's internal UUID, which a test's testId is computed from. Use it only for that: everywhere else a collection is addressed by its id.

Example:

"204b6c93-1c51-4e0f-a13c-e07b9bc60688"

repositoryId

string<uuid>

required

The repository the tests are stored under. The nil UUID for an upload without a repository, or for a repository Trunk does not know.

Example:

"7a1f0e3d-2b4c-4d5e-8f90-123456789abc"

quarantineEnabled

boolean

required

Whether quarantining is on for the collection. When it is off, no test is quarantined.

Example:

true

tests

object[]

required

One entry per requested identifier, in request order. Empty when none were sent. The whole quarantined set is GET /v2/test-collections/{id}/all-quarantined-tests.

Maximum array length: 2000

Show child attributes