> ## Documentation Index > Fetch the complete documentation index at: https://docs.trunk.io/llms.txt > Use this file to discover all available pages before exploring further. # Get quarantine status for a CI run > Reports which tests are quarantined in a collection for one repository, so a CI run can ignore their failures. Send the run's failing tests as `testIdentifiers` to get an answer for each. This is a read sent as `POST` because the identifier list can be large. Requires the **Upload test results** permission. Quarantine changes reach this response within a minute. ## OpenAPI ````yaml /openapi-v2.json post /v2/test-collections/{id}/quarantine-status openapi: 3.1.0 info: title: Trunk API version: 2.0.0 description: >- The Trunk public API. Every endpoint is scoped to a single organization and requires a credential. ## Authentication For automation, send an API key as `Authorization: Bearer `. An organization admin creates one in the Trunk app under **Settings → Developer → API Keys**, and chooses the merge-queue permissions it holds. A key with no permissions can read merge queues but change nothing. Those permissions scope merge queue only: every key can use the Flaky Tests and Dynamic CI endpoints, including their writes, whatever permissions it holds. A short-lived first-party token in the `x-trunk-token` header is what the `trunk` CLI sends after `trunk auth login`. A GitHub Actions job can upload impacted targets with no Trunk secret: the `trunk-io/login` action exchanges the run's own GitHub credential (its OIDC token, or on a pull request from a fork its `GITHUB_TOKEN`) for a short-lived first-party token. That token is accepted only by `PUT /v2/impacted-targets`, for the run's own repository — and on a fork pull request, only for that pull request and its head sha. ## Errors Every 4xx and 5xx response is a `ErrorResponse`: `{ "error": { "code", "message" } }`. Switch on `code`, which is stable; `message` is prose and may change at any time. **An authorization denial on a read is reported as `404`, not `403`** — whether a resource exists must not leak across organizations, so a resource in another organization is indistinguishable from one that does not exist. `403 INSUFFICIENT_PERMISSIONS` means the credential is valid but is not permitted the action (or carries no organization). Every response carries an `X-Request-Id` header. Quote it in support requests. ## Rate limiting Requests are limited per organization (currently 100 requests/second). Exceeding it returns `429` with `RATE_LIMIT_EXCEEDED`; retry with backoff. Note that the limit is enforced at the edge, which does not yet wrap its `429` in the `ErrorResponse` envelope described above — treat any `429` as rate limiting regardless of body. ## Compatibility Within v2, Trunk may add: new endpoints, new **optional** response fields, new members to any enum (including new `code` values, new queue-entry states, and new providers), and new optional request parameters. **Clients must tolerate values and fields they do not recognize** rather than failing closed — a client that switches exhaustively over an enum will break when a member is added. Removals and semantic changes require a new major version. ## Provider support Merge queues, verification runs and checks are **GitHub-only** today; `Check.provider` has a single member for that reason. Impacted-target uploads additionally require a `github.com` repository named `owner/repo`. The `Provider` enum lists values the repository index can store, not surfaces that are fully supported. ## Not yet available A pull request's numeric **position** in its queue is not exposed, and list responses are not ordered by queue position. `GET /v2/merge-queues/{id}/order` returns the order the engine will consider pull requests in, but an array index there is not a wait: use a pending entry's `directlyAhead` rather than counting, and `GET /v2/pull-requests/{id}/queue-entry-estimate` for when it is expected to merge (on queues that serve estimates). This API delivers no events of its own — poll it, or subscribe to [Merge Queue's webhooks](https://docs.trunk.io/merge-queue/webhooks). `Idempotency-Key` is not yet honored, so a mutation that times out must be reconciled by reading the resource back rather than blindly retried. contact: name: Trunk Support url: https://docs.trunk.io servers: - url: https://api.trunk.io description: Production security: - apiKey: [] - trunkToken: [] tags: - name: mergeQueues x-group: Merge Queues - name: pullRequests x-group: Pull Requests - name: mergeQueueVerificationRuns x-group: Verification Runs - name: impactedTargets x-group: Impacted Targets - name: repositories x-group: Repositories - name: dynamicCi x-group: Dynamic CI - name: ciJobs x-group: CI Jobs - name: ciWorkflowRuns x-group: CI Workflow Runs - name: ciFailureClusters x-group: CI Failure Clusters - name: testCollections x-group: Test Collections - name: tests x-group: Tests - name: testUploads x-group: Test Uploads paths: /v2/test-collections/{id}/quarantine-status: post: tags: - testCollections summary: Get quarantine status for a CI run description: >- Reports which tests are quarantined in a collection for one repository, so a CI run can ignore their failures. Send the run's failing tests as `testIdentifiers` to get an answer for each. This is a read sent as `POST` because the identifier list can be large. Requires the **Upload test results** permission. Quarantine changes reach this response within a minute. operationId: testCollections.getQuarantineStatus parameters: - schema: type: string pattern: ^[0-9A-Za-z]{8}$ description: 'The collection''s id: 8 alphanumeric characters.' example: aB3xY9kQ required: true description: 'The collection''s id: 8 alphanumeric characters.' name: id in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QuarantineStatusRequest' responses: '200': description: The collection's quarantine status content: application/json: schema: $ref: '#/components/schemas/QuarantineStatus' '400': description: '`VALIDATION_FAILED`' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: '`AUTHENTICATION_REQUIRED` | `INVALID_TOKEN`' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: '`INSUFFICIENT_PERMISSIONS`' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: '`TEST_COLLECTION_NOT_FOUND`' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: '`RATE_LIMIT_EXCEEDED`' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: '`INTERNAL_ERROR`' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: QuarantineStatusRequest: type: object properties: repo: type: - object - 'null' properties: host: type: string minLength: 1 example: github.com owner: type: string minLength: 1 example: acme name: type: string minLength: 1 example: web required: - host - owner - name description: >- The repository the tests ran in, as the CLI reads it from git. `null` for an upload made without a repository (`--no-repo`). testIdentifiers: type: array items: type: object properties: id: type: string description: >- The CLI's id for the test, in UUID form. When present, the test is matched by it alone. example: 88e5353c-190c-5dce-9d06-0e66c3e062b1 name: type: string example: renders the checkout total parentName: type: string example: CheckoutSuite className: type: string description: >- Narrows a match by name. Ignored when `id` is present or when empty. example: CheckoutSuiteTest required: - name - parentName maxItems: 2000 description: >- The tests to report on, usually the run's failures. Each one gets an entry in `tests`, in this order. required: - repo description: The repository and the tests to look up. QuarantineStatus: type: object properties: testCollectionUuid: type: string format: uuid description: >- 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: type: string format: uuid description: >- 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: type: boolean description: >- Whether quarantining is on for the collection. When it is off, no test is quarantined. example: true tests: type: array items: $ref: '#/components/schemas/QuarantineStatusTest' maxItems: 2000 description: >- One entry per requested identifier, in request order. Empty when none were sent. The whole quarantined set is `GET /v2/test-collections/{id}/all-quarantined-tests`. required: - testCollectionUuid - repositoryId - quarantineEnabled - tests ErrorResponse: type: object properties: error: type: object properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string description: >- Human-readable description of what went wrong. Not stable — do not parse. example: No merge queue found with ID xK9mP2nQ required: - code - message required: - error description: >- The uniform error envelope. Every 4xx and 5xx response in this API has this shape. QuarantineStatusTest: type: object properties: clientTestId: type: - string - 'null' description: The identifier's `id`, echoed so the caller can match it. example: 88e5353c-190c-5dce-9d06-0e66c3e062b1 testId: type: - string - 'null' format: uuid description: >- The test's id, as `GET /v2/tests/{testId}` takes it. Always present when the identifier had an `id`. Without one, present only when the identifier matched a quarantined test by name. example: bfeebcf4-72d1-887d-8bcd-788d0dec7f97 quarantined: type: boolean description: >- Whether the test is quarantined, so its failure should not fail the run. example: true required: - clientTestId - testId - quarantined ErrorCode: type: string enum: - AUTHENTICATION_REQUIRED - INVALID_TOKEN - INSUFFICIENT_PERMISSIONS - INTERNAL_ERROR - VALIDATION_FAILED - NOT_FOUND - INVALID_CURSOR - MERGE_QUEUE_NOT_FOUND - PR_ALREADY_ENQUEUED - PR_NOT_ENQUEUEABLE - UPSTREAM_ERROR - VERIFICATION_RUN_NOT_FOUND - PR_NOT_FOUND - REPOSITORY_NOT_FOUND - IMPACTED_TARGETS_UNSUPPORTED - QUEUE_ALREADY_EXISTS - QUEUE_HAS_ACTIVE_ENTRIES - MODE_CHANGE_IN_PROGRESS - PR_NOT_IN_ACTIVE_STATE - MERGE_QUEUE_NOT_CREATABLE - PR_TESTS_NOT_RESTARTABLE - ALLOWED_BOT_SUBMITTERS_FROZEN - ESTIMATE_NOT_ENABLED - PROVIDER_URL_NOT_FOUND - CI_HOST_UNSUPPORTED - CI_SCOPE_NOT_FOUND - CI_JOB_NOT_FOUND - CI_FAILURE_CLUSTER_NOT_FOUND - TEST_COLLECTION_NOT_FOUND - TEST_NOT_FOUND - TEST_UPLOAD_NOT_FOUND - TICKETING_NOT_CONFIGURED - TICKETING_CREDENTIALS_INVALID - TICKETING_SITE_REFUSED - TICKET_NOT_FOUND - TICKET_LINK_CONFLICT - RATE_LIMIT_EXCEEDED description: >- Stable machine-readable error identifier. Switch on this, never on `message`. A shipped code's meaning never changes, but **new codes may be added within v2** — treat an unrecognized code as a generic failure of its HTTP status rather than failing closed. example: MERGE_QUEUE_NOT_FOUND securitySchemes: apiKey: type: http scheme: bearer description: >- An API key, sent as `Authorization: Bearer `. An organization admin creates one in the Trunk app under **Settings → Developer → API Keys** and chooses the merge-queue permissions it holds; a key with none can read merge queues but change nothing. Those permissions scope merge queue only: every key can use the Flaky Tests and Dynamic CI endpoints, including their writes, whatever permissions it holds. trunkToken: type: apiKey in: header name: x-trunk-token description: >- A short-lived first-party token, sent in the `x-trunk-token` header. The `trunk` CLI sends one after `trunk auth login`, and the `trunk-io/login` action obtains one for a GitHub Actions run. **A token from a GitHub Actions run can only upload impacted targets** (`PUT /v2/impacted-targets`), for the repository the run belongs to; every other endpoint refuses it. ````