Skip to main content
POST
Get quarantine status for a CI run

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 permissions it holds. A key with none can read merge queues but change nothing in them. Permissions cover merge queues and test-result uploads, including the quarantine lookups a CI run makes before it uploads; any key can call the other Flaky Tests and Dynamic CI endpoints, including their writes.

Path Parameters

id
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).

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

A test, by id, or by name and parentName when it has no id. Sending only id keeps the request small.

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 POST /v2/test-collections/{id}/all-quarantined-tests.

Maximum array length: 2000