v2

latestOpenAPI 3.1.0UNLICENSED2026-07-26210239.8 KB

Update the merge queue.

post/updateQueue

Request body

targetBranchstring required

The branch that the merge queue is targeting.

state'running' | 'paused' | 'draining'

The desired state of the merge queue. Valid values: RUNNING, PAUSED, DRAINING.

concurrencyinteger

The number of PRs or batches of PRs the queue can test at once.

bisectionConcurrencyinteger

The number of tests the merge queue can run when bisecting a batch to figure out what PR in the batch failed.

testingTimeoutMinutesinteger

The maximum number of minutes the merge queue will wait for tests to complete before timing out.

pendingFailureDepthinteger

When enabled, PRs that fail tests will wait for the specified number of PRs below them to finish testing before getting kicked from the queue. This works best with optimistic merging enabled.

canOptimisticallyMergeboolean

When enabled, a PR that passes tests will also cause any PR ahead of it in the queue to also get marked as passing, since tests have passed with those commits.

batchboolean

Enable or disable batching. When enabled, the merge queue will group PRs into batches for testing.

batchingMaxWaitTimeMinutesinteger

The maximum number of minutes the merge queue will wait to collect PRs into a batch before starting tests.

batchingMinSizeinteger

The minimum number of PRs required to form a batch.

mode'single' | 'parallel'

The queue mode. 'single' processes PRs one at a time. 'parallel' processes multiple PRs concurrently.

commentsEnabledboolean

Whether or not Merge Queue will post GitHub comments on PRs.

commandsEnabledboolean

Whether or not users are allowed to submit PRs to the merge queue by commenting /trunk merge.

createPrsForTestingBranchesboolean

Whether or not the merge queue will create PRs for its testing branches, allowing CI to run on them.

directMergeMode'off' | 'always'

Allow PRs to merge directly into the target branch if they're up to date with the target branch when submitting them to the queue instead of running tests on them in the merge queue.

optimizationMode'off' | 'bisection_skip_redundant_tests'

The optimization strategy for the merge queue. 'off' disables optimizations. 'bisection_skip_redundant_tests' uses bisection and skips redundant tests.

mergeMethod'merge_commit' | 'squash' | 'rebase'

The Git merge method used when merging PRs into the target branch. Valid values: merge_commit, squash, rebase.

statusCheckEnabledboolean

Post a GitHub status check on PRs with the status of the PR in the merge queue.

requiredStatusesstring[]

Allows setting the statuses that must pass when the merge queue performs tests in order for a PR to merge. Setting the statuses here will override GitHub branch protection settings or your .trunk/trunk.yaml.

deleteRequiredStatusesboolean

Removes a manually specified set of required statuses. After this, the statuses that must pass when the merge queue performs testing will be pulled from either GitHub branch protection settings or your .trunk/trunk.yaml.

Response

OK

state'running' | 'paused' | 'draining' | 'switching_modes' required

The state of the merge queue. See https://docs.trunk.io/merge-queue/administration/advanced-settings#merge-queue-state for the full description of each state.

branchstring required
concurrencynumber required
testingTimeoutMinutesnumber required
mode'single' | 'parallel' required
canOptimisticallyMergeboolean required
pendingFailureDepthnumber required
batchboolean required
batchingMaxWaitTimeMinutesnumber required
batchingMinSizenumber required
createPrsForTestingBranchesboolean required
commentsEnabledboolean required
commandsEnabledboolean required
statusCheckEnabledboolean required
bisectionConcurrencynumber required
requiredStatusesstring[] required
directMergeMode'off' | 'always' required

Controls whether PRs can skip the queue's test run and merge directly when already up to date with the target branch. See https://docs.trunk.io/merge-queue/administration/advanced-settings#direct-merge-to-main for details.

optimizationMode'off' | 'bisection_skip_redundant_tests' required

The optimization strategy for the merge queue. off — no optimizations. See https://docs.trunk.io/merge-queue/optimizations/batching#test-caching-during-bisection for details on bisection_skip_redundant_tests.

mergeMethod'merge_commit' | 'squash' | 'rebase' required

The Git strategy used to merge a PR into the target branch. See https://docs.trunk.io/merge-queue/administration/advanced-settings#merge-method for details.