Skip to main content
POST
Quarantine a flaky test of an application

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

application_id
string<uuid>
required

Body

application/json
test_key
string
required

The test's key, as the run test summary, the history and the candidates answer it.

Pattern: ^[0-9a-f]{64}$
reason
string
required
Required string length: 1 - 500

Response

The test was quarantined.

id
string<uuid>
required
test_key
string
required
Pattern: ^[0-9a-f]{64}$
suite
string | null
required
name
string
required
file
string | null
required
reason
string
required
source
enum<string>
required
Available options:
manual
flaky_rate
number
required

The default-branch flaky rate the decision rested on.

Required range: 0 <= x <= 1
samples
integer
required

The observed default-branch runs that rate rested on.

Required range: x >= 0
created_by_email
string | null
required
created_at
string<date-time>
required
consecutive_passes
integer
required

The test's default-branch passes in a row while the quarantine is live; a failed or flaky run resets it.

Required range: x >= 0
released_at
string<date-time> | null
required

Null while the quarantine is live.

released_by_email
string | null
required

"system" for a release after enough passes.

release_reason
enum<string> | null
required
Available options:
manual,
passes,
null
release_note
string | null
required