Merge Queue

Public Trunk Merge Queue API. All requests should be authenticated.

The Trunk Merge Queue API provides access to submit PRs for testing and merging, canceling PRs, and providing extra information to optimize the queue. The API is an HTTP REST API, returns JSON from all requests, and uses standard HTTP response codes.

All requests must be authenticated by providing the x-api-token header.

Submit a pull request to be tested and merged

post

/submitPullRequest

Authorizations

Body

repoobject

Example: {"host":"github.com","owner":"trunk-io","name":"trunk"}

probject

Example: {"number":1}

targetBranchstring

The branch the merge queue will be merging PRs into

Example: main

priorityone of

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.trunk.io/v1/submitPullRequest' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetBranch":"main","priority":"medium","repo":{"host":"github.com","owner":"trunk-io","name":"trunk"},"pr":{"number":1}}'

200

401

200

No body

OK

Get information on a pull request that has been submitted to the queue

post

/getSubmittedPullRequest

Authorizations

Body

repoobject

Example: {"host":"github.com","owner":"trunk-io","name":"trunk"}

probject

Example: {"number":1}

targetBranchstring

The branch the merge queue will be merging PRs into

Example: main

priorityone of

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.trunk.io/v1/getSubmittedPullRequest' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetBranch":"main","priority":"medium","repo":{"host":"github.com","owner":"trunk-io","name":"trunk"},"pr":{"number":1}}'

200

401

404

200

{
  "id": "1234567890abcdef",
  "state": "PENDING",
  "stateChangedAt": "2021-01-01T00:00:00Z",
  "priorityValue": 100,
  "priorityName": "medium",
  "usedDefaultPriorityName": "medium",
  "skipTheLine": false,
  "isCurrentlySubmittedToQueue": true,
  "prNumber": 1,
  "prTitle": "Add new feature",
  "prSha": "1234567890abcdef",
  "prBaseBranch": "main",
  "prAuthor": "dependabot",
  "readiness": {
    "hasImpactedTargets": false,
    "requiresImpactedTargets": false,
    "doesBaseBranchMatch": true,
    "gitHubMergeability": "MERGEABLE"
  }
}

Information on the pull request

Restarts tests on a PR in the queue without moving its position or causing other PRs to be retested

post

/restartTestsOnPullRequest

Authorizations

Body

repoobject

Example: {"host":"github.com","owner":"trunk-io","name":"trunk"}

probject

Example: {"number":1}

targetBranchstring

The branch the merge queue will be merging PRs into

Example: main

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.trunk.io/v1/restartTestsOnPullRequest' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetBranch":"main","repo":{"host":"github.com","owner":"trunk-io","name":"trunk"},"pr":{"number":1}}'

200

401

200

No body

OK

Cancel a pull request already in the queue.

post

/cancelPullRequest

Authorizations

Body

repoobject

Example: {"host":"github.com","owner":"trunk-io","name":"trunk"}

probject

Example: {"number":1}

targetBranchstring

The branch the merge queue will be merging PRs into

Example: main

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.trunk.io/v1/cancelPullRequest' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetBranch":"main","repo":{"host":"github.com","owner":"trunk-io","name":"trunk"},"pr":{"number":1}}'

200

401

200

No body

OK

Get information on your merge queue and the PRs currently in it

post

/getQueue

Authorizations

Body

repoobject

Example: {"host":"github.com","owner":"trunk-io","name":"trunk"}

targetBranchstring

The branch the merge queue will be merging PRs into

Example: main

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.trunk.io/v1/getQueue' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetBranch":"main","repo":{"host":"github.com","owner":"trunk-io","name":"trunk"}}'

200

401

404

200

{
  "state": "RUNNING",
  "branch": "main",
  "concurrency": 1,
  "testingTimeoutMins": 60,
  "mode": "SINGLE",
  "canOptimisticallyMerge": true,
  "pendingFailureDepth": 1,
  "batchingMode": "SPECULATIVE",
  "batchingMaxWaitTimeMins": 60,
  "batchingMinSize": 1,
  "createPrsForTestingBranches": true,
  "enqueuedPullRequests": [
    {
      "id": "1234567890abcdef",
      "state": "PENDING",
      "stateChangedAt": "2021-01-01T00:00:00Z",
      "priorityValue": 100,
      "priorityName": "medium",
      "usedDefaultPriorityName": "medium",
      "skipTheLine": false,
      "prNumber": 1,
      "prTitle": "Add new feature",
      "prSha": "1234567890abcdef",
      "prBaseBranch": "main",
      "prAuthor": "dependabot"
    }
  ]
}

Information on the pull request

Set impacted targets

Upload impacted targets for the PR and its current SHA. Used specifically when running the queue in Parallel mode

post

/setImpactedTargets

Authorizations

Body

repoobject

Example: {"host":"github.com","owner":"trunk-io","name":"trunk"}

probject

Example: {"number":1,"sha":"1234567890abcdef"}

targetBranchstring

The branch the merge queue will be merging PRs into

Example: main

impactedTargetsone of

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.trunk.io/v1/setImpactedTargets' \
  --header 'x-api-token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"targetBranch":"main","impactedTargets":["services_backend","services_frontend"],"repo":{"host":"github.com","owner":"trunk-io","name":"trunk"},"pr":{"number":1,"sha":"1234567890abcdef"}}'

200

401

200

No body

OK