View as Markdown
API

Test states API

The new test states endpoint lists and manages the tests you have quarantined, and replaces the quarantine endpoints.

Quarantine is one state a test can be in, and the API now models it that way. The test states endpoint, /v1/ci/{owner}/repositories/{repository}/test-states, lists, creates, reads, updates and deletes them, and every test state says which state it is in (today, always quarantined).

  • List a repository’s test states, filtered by state, branch, pipeline, job, test name, source or health, one page at a time.
  • Put a test in a state for a branch, pipeline and job, or for every one of them.
  • Update or remove a test state by its ID. The quarantine endpoints keep working but are deprecated: their responses carry a Deprecation header. If your scripts call them, move to the test states endpoint. The API reference lists every parameter.

Was this page helpful?