test_insights

Get a quarantined test

Changed on

Deprecated: use the test states API, /ci/{owner}/repositories/{repository}/test-states.

Retrieve a single quarantined test by its quarantine ID.

get/ci/{owner}/repositories/{repository}/quarantines/{quarantine_id}

Request

  • Base URL: https://api.mergify.com/v1
  • URL: https://api.mergify.com/v1/ci/{owner}/repositories/{repository}/quarantines/{quarantine_id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

quarantine_idstring uuid required
repositorystring required

The name of the repository

ownerstring required

The owner of the repository

Response

Successful Response

idstring uuid required

Unique identifier of the quarantine record.

test_namestring required

Fully qualified name of the quarantined test.

test_idstring uuid required

Stable identifier of the test, derived from its name. Identical across every quarantine of the same test and matches the test_id filter on the list endpoint.

reasonstring required

Free-form reason recorded when the test was quarantined.

issue_urlstring nullable required

Link to where the fix of the test is tracked, such as an issue. null when none was given.

branchstring nullable required

Deprecated: use branch_name.

branch_namestring nullable required

Branch this quarantine applies to. null means the test is quarantined on every branch.

pipeline_namestring nullable required

Pipeline this quarantine applies to. null means the test is quarantined in every pipeline.

job_namestring nullable required

Job this quarantine applies to. null means the test is quarantined in every job.

created_atstring date-time required

UTC timestamp when the test was added to quarantine.

source'manual' | 'auto'
health_status'healthy' | 'flaky' | 'broken' required
is_recoveredboolean required

True when recent runs of this test are healthy, suggesting the test could be unquarantined.

unquarantine_when_healthyboolean required

True when Mergify unquarantines this test once it recovers.

Changes