test_insights

Mark a test as quarantined

Changed on

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

Add a test to the CI Quarantine for a repository

post/ci/{owner}/repositories/{repository}/quarantines

Request

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

Path parameters

repositorystring required

The name of the repository

ownerstring required

The owner of the repository

Request body

test_namestring required

The fully qualified name of the test that needs to be quarantined

reasonstring required

Reason for the test being added to the quarantine

issue_urlstring nullable

Link to where the fix of the test is tracked, such as an issue in your issue tracker. Must be an http or https URL.

branch_namestring nullable

Branch name on which the test should be quarantined. If not specified, it will be quarantined on all branches. branch is accepted as a deprecated alias.

pipeline_namestring nullable

Pipeline in which the test should be quarantined. If not specified, it will be quarantined in all pipelines.

job_namestring nullable

Job in which the test should be quarantined. If not specified, it will be quarantined in all jobs.

unquarantine_when_healthyboolean

Unquarantine the test once it recovers, when Mergify no longer detects it as flaky or broken.

branchstring nullable

Deprecated: use branch_name.

Response

Successful Response

idstring uuid required

The ID of the created quarantine

Changes

  • f0fe01773ba8Revision changes
    • warning

      added the new TEST_STATE_OVERLAP enum value to the response property for the response status

    • info

      endpoint deprecated

  • 24834a2d3673Revision changes
    • breaking

      removed the media type application/json for the response with the status

    • info

      removed the REPOSITORY_NOT_RECORDED enum value from the response property for the response status