Merge

Public Merge API. All requests should be authenticated.

The Trunk Merge 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

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

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();

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

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

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();