> ## 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.

# Set quarantine overrides on many tests

> Requires the **Quarantine tests** permission.

Sets the quarantine override of each listed test, as `POST /v2/tests/{testId}/quarantine` does for one, and reports each test's outcome in request order. The tests may be in different collections. At most 100 items, and a test listed twice refuses the whole request with `VALIDATION_FAILED`.

Each item either `succeeded`, was `unchanged` (already in that mode; `reason` is not recorded for it), or `failed` with an `error`: `TEST_NOT_FOUND` for an id that does not resolve to a test you can see (another organization's included), `INSUFFICIENT_PERMISSIONS` for a test whose collection lets only admins set overrides, and `INTERNAL_ERROR` for one that could not be saved, which wrote nothing and may be sent again. One item failing does not undo the others. A caller without the permission is refused as a whole with `403`.

The override is recorded as set by the API token, or by the person whose token made the call. A change a person makes sends the `v2.test_case.quarantining_setting_changed` webhook; a change made with an API token does not yet.

`Idempotency-Key` is not honored. The write is idempotent by state, so a request whose outcome is unknown (a `504` or a dropped connection) is safe to send again: a test already in the requested mode reports `unchanged`.



## OpenAPI

````yaml /openapi-v2.json post /v2/tests/quarantine
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 <key>`. An
    organization admin creates one in the Trunk app under **Settings → Developer
    → API Keys**, and chooses the permissions it holds. A key with no
    permissions can read merge queues but change nothing in them. Each write's
    description names the permission it needs, if any. Permissions cover merge
    queues and test-result uploads, including the quarantine lookups a CI run
    makes before it uploads; any key can call the other Flaky Tests and Dynamic
    CI endpoints, including their writes.


    A short-lived token in the `x-trunk-token` header is what Trunk's own tools
    send, such as the `trunk` CLI after `trunk auth login`. Your own
    integrations should use an API key.


    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


    Errors from the API are an `ErrorResponse`: `{ "error": { "code", "message"
    } }`. Switch on `code`, which is stable; `message` is prose and may change
    at any time.


    Some responses don't have this shape. Trunk's edge answers `401`, `403` for
    some credential problems (including a request with no credential), `429`,
    and gateway errors such as `503` before the request reaches the API. The API
    itself answers `413` for a body over 512 KB and `504` for a request that
    runs past its time limit (usually 5 seconds), both as plain text. Read
    `error.code` only when the body is JSON with an `error` object, and
    otherwise branch on the status code.


    **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 from the API carries an `X-Request-Id` header; edge responses
    may not. Quote it in support requests.


    ## Rate limiting


    Most requests share one limit per organization (currently 100 requests per
    second), across every API key, user, and CLI session in it. Some requests
    have limits of their own and don't count toward it: `GET` requests on paths
    that start with `/v2/pull-requests`, `/v2/ci-jobs`, `/v2/ci-workflow-runs`,
    or `/v2/ci-failure-clusters` (5 per second per API key or user); the merge
    queue metrics endpoints (5 per second per organization); impacted-target
    uploads from a GitHub Actions login (10 per second per repository, and
    separately for its fork pull requests); test-result uploads (1000 per second
    per organization) and quarantine lookups (250 per second per organization).
    Exceeding a limit returns `429`; retry with backoff. The limit is enforced
    at the edge, which does not yet wrap its `429` in the `ErrorResponse`
    envelope or send `Retry-After`, so 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. `PUT
    /v2/impacted-targets` accepts GitHub and GitLab repositories. A GitHub
    Actions login (the `trunk-io/login` action, or `trunk auth login
    --github-actions`) uploads only for its own GitHub repository. 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
  - name: detectionEvents
    x-group: Detection Events
  - name: monitors
    x-group: Monitors
  - name: monitorTests
    x-group: Monitor Tests
paths:
  /v2/tests/quarantine:
    post:
      tags:
        - tests
      summary: Set quarantine overrides on many tests
      description: >-
        Requires the **Quarantine tests** permission.


        Sets the quarantine override of each listed test, as `POST
        /v2/tests/{testId}/quarantine` does for one, and reports each test's
        outcome in request order. The tests may be in different collections. At
        most 100 items, and a test listed twice refuses the whole request with
        `VALIDATION_FAILED`.


        Each item either `succeeded`, was `unchanged` (already in that mode;
        `reason` is not recorded for it), or `failed` with an `error`:
        `TEST_NOT_FOUND` for an id that does not resolve to a test you can see
        (another organization's included), `INSUFFICIENT_PERMISSIONS` for a test
        whose collection lets only admins set overrides, and `INTERNAL_ERROR`
        for one that could not be saved, which wrote nothing and may be sent
        again. One item failing does not undo the others. A caller without the
        permission is refused as a whole with `403`.


        The override is recorded as set by the API token, or by the person whose
        token made the call. A change a person makes sends the
        `v2.test_case.quarantining_setting_changed` webhook; a change made with
        an API token does not yet.


        `Idempotency-Key` is not honored. The write is idempotent by state, so a
        request whose outcome is unknown (a `504` or a dropped connection) is
        safe to send again: a test already in the requested mode reports
        `unchanged`.
      operationId: tests.setQuarantineMany
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetQuarantineManyRequest'
      responses:
        '200':
          description: Each test's outcome, in request order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkResult'
        '400':
          description: '`VALIDATION_FAILED`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                VALIDATION_FAILED:
                  summary: VALIDATION_FAILED
                  value:
                    error:
                      code: VALIDATION_FAILED
                      message: 'Invalid input: expected string, received undefined'
        '401':
          description: >-
            `AUTHENTICATION_REQUIRED` | `INVALID_TOKEN`. A malformed, expired,
            or deleted credential. Trunk's edge usually answers this before the
            request reaches the API, with a body that is not this envelope
            (`{"error": "unauthorized: invalid api key"}` for a bad API key, or
            plain text for a bad `x-trunk-token`), so branch on the status. A
            request with no credential at all gets `403` from the edge.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AUTHENTICATION_REQUIRED:
                  summary: AUTHENTICATION_REQUIRED
                  value:
                    error:
                      code: AUTHENTICATION_REQUIRED
                      message: No credential was supplied
                INVALID_TOKEN:
                  summary: INVALID_TOKEN
                  value:
                    error:
                      code: INVALID_TOKEN
                      message: The supplied token failed verification
        '403':
          description: '`INSUFFICIENT_PERMISSIONS`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INSUFFICIENT_PERMISSIONS:
                  summary: INSUFFICIENT_PERMISSIONS
                  value:
                    error:
                      code: INSUFFICIENT_PERMISSIONS
                      message: >-
                        The supplied credential is missing the required
                        permission
        '429':
          description: >-
            `RATE_LIMIT_EXCEEDED`. Trunk's edge answers this, and does not yet
            wrap it in the error envelope or send `Retry-After`: treat any `429`
            as rate limiting, whatever its body, and retry with backoff.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                RATE_LIMIT_EXCEEDED:
                  summary: RATE_LIMIT_EXCEEDED
                  value:
                    error:
                      code: RATE_LIMIT_EXCEEDED
                      message: Rate limit exceeded; retry with backoff
        '500':
          description: '`INTERNAL_ERROR`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                INTERNAL_ERROR:
                  summary: INTERNAL_ERROR
                  value:
                    error:
                      code: INTERNAL_ERROR
                      message: An unexpected error occurred
components:
  schemas:
    SetQuarantineManyRequest:
      type: object
      properties:
        reason:
          type: string
          minLength: 1
          maxLength: 1000
          description: >-
            Why the override was set, shown with it in the web app and on the
            test's `quarantineOverride`.
          example: Fails only on the Windows shard; tracked in TRUNK-1234.
        items:
          type: array
          items:
            $ref: '#/components/schemas/SetQuarantineItem'
          minItems: 1
          maxItems: 100
          description: The tests to change, at most 100, each id once.
      required:
        - items
      additionalProperties: false
      description: >-
        Quarantine overrides to set on many tests, with one `reason` for all of
        them.
    BulkResult:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/BulkResultItem'
          maxItems: 100
          description: One entry per requested item, in request order.
        succeededCount:
          type: integer
          example: 2
        unchangedCount:
          type: integer
          example: 1
        failedCount:
          type: integer
          example: 0
      required:
        - results
        - succeededCount
        - unchangedCount
        - failedCount
      description: >-
        The outcome of each item of a many-form request. A request that is
        refused as a whole answers a coded error instead, never a `BulkResult`.
    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: An unexpected error occurred
          required:
            - code
            - message
      required:
        - error
      description: >-
        The error envelope. Every error this API itself returns has this shape,
        except a `413` for a body over 512 KB and a `504` for a request that
        runs past its time limit, which are plain text. Responses from Trunk's
        edge, such as a `401`, a `403` for a missing credential, a `429` or a
        `503`, can arrive before the request reaches the API and may not have
        it, so read `error.code` only when the body is JSON with an `error`
        object.
    SetQuarantineItem:
      type: object
      properties:
        testId:
          type: string
          minLength: 1
          description: The test's globally unique id.
          example: bfeebcf4-0000-8000-8000-000000000001
        mode:
          $ref: '#/components/schemas/SetQuarantineMode'
      required:
        - testId
        - mode
      additionalProperties: false
    BulkResultItem:
      type: object
      properties:
        testId:
          type: string
          example: bfeebcf4-0000-8000-8000-000000000001
        status:
          $ref: '#/components/schemas/BulkItemStatus'
        quarantineOverride:
          anyOf:
            - $ref: '#/components/schemas/QuarantineOverride'
            - type: 'null'
          description: >-
            Quarantine: the test's override after the call, null when none is in
            force. Absent on a failed item.
        monitorTestState:
          allOf:
            - $ref: '#/components/schemas/MonitorTestState'
            - description: >-
                Mute and unmute: the monitor's state for the test after the
                call. Absent on a failed item.
        error:
          $ref: '#/components/schemas/BulkItemError'
      required:
        - testId
        - status
    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
        - IMPACTED_TARGETS_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
        - PR_RERUN_FEATURE_DISABLED
        - PR_RERUN_NOT_PENDING_FAILURE
        - PR_RERUN_QUEUE_DOES_NOT_KEEP_FAILED_RUNS
        - PR_RERUN_NOT_A_REQUIRED_CHECK_FAILURE
        - PR_RERUN_CHECK_NOT_RERUNNABLE
        - PR_RERUN_RUN_TORN_DOWN
        - PR_RERUN_HOLD_LIMIT_REACHED
        - PR_RERUN_FORGE_NOT_SUPPORTED
        - PROVIDER_URL_NOT_FOUND
        - CI_HOST_UNSUPPORTED
        - CI_SCOPE_NOT_FOUND
        - PATHS_FILTER_CONFLICT
        - CI_JOB_NOT_FOUND
        - CI_FAILURE_CLUSTER_NOT_FOUND
        - TEST_COLLECTION_NOT_FOUND
        - TEST_NOT_FOUND
        - TEST_UPLOAD_NOT_FOUND
        - MONITOR_NOT_FOUND
        - MONITOR_LIMIT_EXCEEDED
        - MONITOR_NOT_ACTIVE
        - OUT_OF_RANGE
        - TEST_UNAVAILABLE
        - TICKETING_NOT_CONFIGURED
        - TICKETING_CREDENTIALS_INVALID
        - TICKETING_SITE_REFUSED
        - TICKET_NOT_FOUND
        - TICKET_NOT_LINKED
        - TICKET_LINK_CONFLICT
        - TEST_ALREADY_LINKED
        - TICKET_FIELDS_REJECTED
        - TICKET_CONTENT_UNAVAILABLE
        - TICKETING_CREATE_REFUSED
        - 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: INTERNAL_ERROR
    SetQuarantineMode:
      type: string
      enum:
        - alwaysQuarantine
        - neverQuarantine
        - clear
      description: >-
        `alwaysQuarantine` quarantines the test whatever its status.
        `neverQuarantine` keeps it out of quarantine whatever its status.
        `clear` removes the override, so the collection's quarantine settings
        and the test's status decide again.
      example: neverQuarantine
    BulkItemStatus:
      type: string
      enum:
        - succeeded
        - unchanged
        - failed
      description: >-
        `succeeded` changed the test. `unchanged` found it already in the
        requested state and wrote nothing. `failed` carries an `error` and
        changed nothing that stayed.
      example: succeeded
    QuarantineOverride:
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/QuarantineMode'
        reason:
          type:
            - string
            - 'null'
          example: flaky in CI
        createdAt:
          type: string
          format: date-time
          example: '2026-06-05T00:00:00.000Z'
      required:
        - mode
        - reason
        - createdAt
    MonitorTestState:
      type: object
      properties:
        monitorId:
          type: string
          example: 1a2b3c4d-5e6f-4a1b-8c9d-0e1f2a3b4c5d
        testId:
          type: string
          description: The test's globally unique id.
          example: bfeebcf4-0000-8000-8000-000000000001
        state:
          $ref: '#/components/schemas/MonitorTestStateValue'
        isMuted:
          type: boolean
          description: 'True when a mute is in force; the same as `state: muted`.'
          example: false
        mutedUntil:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the mute ends. Null for a mute with no end, and when the test
            is not muted.
          example: '2026-06-10T00:00:00.000Z'
        mutedBy:
          anyOf:
            - $ref: '#/components/schemas/MuteActor'
            - type: 'null'
          description: Who muted the test. Null when it is not muted.
        muteReason:
          type:
            - string
            - 'null'
          description: Null when no reason was given, or the test is not muted.
          example: Known flake, fix in progress
        lastDetectedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            When the monitor last detected the test: its last pass on retry,
            failure, skip or slow run, or when a new test first ran. Always null
            for a failure-rate monitor, which records no detection time.
          example: '2026-06-03T10:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: >-
            When the monitor's state for the test last changed. A mute or unmute
            moves it.
          example: '2026-06-03T10:00:00.000Z'
      required:
        - monitorId
        - testId
        - state
        - isMuted
        - mutedUntil
        - mutedBy
        - muteReason
        - lastDetectedAt
        - updatedAt
      description: >-
        One test a monitor holds: one it is active on, or one whose mute on it
        is in force.
    BulkItemError:
      type: object
      properties:
        code:
          type: string
          example: TEST_NOT_FOUND
        message:
          type: string
          example: No test found with ID bfeebcf4-0000-8000-8000-000000000001
        param:
          type: string
          description: The request field the error is about.
          example: items[2].testId
      required:
        - code
        - message
        - param
    QuarantineMode:
      type: string
      enum:
        - alwaysQuarantine
        - neverQuarantine
      description: A per-test quarantine override.
      example: alwaysQuarantine
    MonitorTestStateValue:
      type: string
      enum:
        - active
        - muted
      description: >-
        `active` when the monitor is active on the test and has not muted it,
        `muted` when a mute is in force.
      example: active
    MuteActor:
      type: object
      properties:
        displayName:
          type: string
          description: >-
            The name recorded for whoever muted the test, `API token` for a
            token.
          example: Ada Lovelace
      required:
        - displayName
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key, sent as `Authorization: Bearer <key>`. An organization admin
        creates one in the Trunk app under **Settings → Developer → API Keys**
        and chooses the permissions it holds. A key with none can read merge
        queues but change nothing in them. Permissions cover merge queues and
        test-result uploads, including the quarantine lookups a CI run makes
        before it uploads; any key can call the other Flaky Tests and Dynamic CI
        endpoints, including their writes.
    trunkToken:
      type: apiKey
      in: header
      name: x-trunk-token
      description: >-
        A short-lived token that Trunk's own tools send in the `x-trunk-token`
        header: the `trunk` CLI after `trunk auth login`, and the
        `trunk-io/login` action in a GitHub Actions run. Your own integrations
        should use an API key instead. Never send `Authorization` and
        `x-trunk-token` on the same request.


        **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.

````