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

POSThttps://api.trunk.io:433/v1/submitPullRequest

Body

application/json

reporepo (object)

prpr (object)

targetBranchtargetBranch (string)

The branch the merge queue will be merging PRs into

Example: "main"

priorityone of

enumnumber

Response

200401

OK

Request

JavaScriptCurl

const response = await fetch('https://api.trunk.io:433/v1/submitPullRequest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Cancel a pull request already in the queue.

POSThttps://api.trunk.io:433/v1/cancelPullRequest

Body

application/json

reporepo (object)

prpr (object)

targetBranchtargetBranch (string)

The branch the merge queue will be merging PRs into

Example: "main"

Response

200401

OK

Request

JavaScriptCurl

const response = await fetch('https://api.trunk.io:433/v1/cancelPullRequest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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

GEThttps://api.trunk.io:433/v1/host/github/owner/{owner}/name/{name}/branch/{targetBranch}/pr/{prNumber}

Path parameters

owner*string

owning organization of the repo the merge queue is for

Example: "trunk-io"

name*string

name of the repo the merge queue is for

Example: "trunk"

targetBranch*string

The branch the merge queue is merging PRs into

Example: "main"

prNumber*number

The number of the PR to get information on

Example: 1

Response

200401404

Information on the pull request

Body

application/json

idstring

The ID of the merge item in the queue

stateenum

The state of the PR in the queue - see https://docs.trunk.io/merge/reference#pr-states

NOT_READYPENDINGTESTINGTESTS_PASSEDPENDING_FAILUREFAILEDCANCELLEDMERGED

stateChangedAtstring (date-time)

The time the state of the PR changed

priorityValuenumber

The priority value of the PR in the queue - ranges from 0-255 with 0 being the highest

Example: 100

priorityNameenum

The priority name of the PR in the queue. Defaults to medium

Example: "medium"

lowmediumhighurgent

usedDefaultPriorityNameenum

The default priority given to the PR if no explicit priority was specified

Example: "medium"

lowmediumhighurgent

skipTheLineboolean

Whether the PR will skip the line of the queue

Example: false

isCurrentlySubmittedToQueueboolean

Whether the PR is currently submitted to the queue.

readinessprReadiness (object)

pullRequestpullRequest (object)

Request

JavaScriptCurl

const response = await fetch('https://api.trunk.io:433/v1/host/github/owner/{owner}/name/{name}/branch/{targetBranch}/pr/{prNumber}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "state": "NOT_READY",
  "stateChangedAt": "2024-07-26T20:31:51.784Z",
  "priorityValue": 100,
  "priorityName": "medium",
  "usedDefaultPriorityName": "medium",
  "skipTheLine": false,
  "isCurrentlySubmittedToQueue": false,
  "readiness": {
    "hasImpactedTargets": false,
    "requiresImpactedTargets": false,
    "doesBaseBranchMatch": true,
    "gitHubMergeability": "MERGEABLE"
  },
  "pullRequest": {
    "number": 1,
    "title": "Add new feature",
    "sha": "1234567890abcdef",
    "baseBranch": "main",
    "author": "dependabot"
  }
}

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

POSThttps://api.trunk.io:433/v1/restartTestsOnPullRequest

Body

application/json

reporepo (object)

prpr (object)

targetBranchtargetBranch (string)

The branch the merge queue will be merging PRs into

Example: "main"

Response

200401

OK

Request

JavaScriptCurl

const response = await fetch('https://api.trunk.io:433/v1/restartTestsOnPullRequest', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Set impacted targets

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

POSThttps://api.trunk.io:433/v1/setImpactedTargets

Body

application/json

reporepo (object)

prprWithSha (object)

targetBranchtargetBranch (string)

The branch the merge queue will be merging PRs into

Example: "main"

impactedTargetsone of

array of stringenum

Response

200401

OK

Request

JavaScriptCurl

const response = await fetch('https://api.trunk.io:433/v1/setImpactedTargets', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();