Merge Pilot REST API reference
Every endpoint of the Merge Pilot REST API, with its parameters, request and response schemas and examples. Programs authenticate with an API token sent as a bearer token. Start with the overview, authentication, conventions and examples, or download the OpenAPI document.
Authentication
GET /auth/me— The signed-in accountPUT /auth/me— Change own display name or languageGET /auth/me/sso— My identity providers
Merge requests
GET /merge-requests— List merge requestsPOST /merge-requests/fetch— Process a merge request by its numberGET /merge-requests/lookup— Find a merge request's ID by repository and numberPOST /merge-requests/sync-states— Queue a background re-read of the open merge requests' state from the VCSGET /merge-requests/{id}— Get a merge request with its decision and approval stateGET /merge-requests/{id}/timeline— Jobs and audit entries of a merge request, newest firstPOST /merge-requests/{id}/votes— Approve or reject the merge request's change approvalPOST /merge-requests/{id}/rejection/withdraw— Withdraw a rejection of the change approvalPOST /merge-requests/{id}/freeze-release— Let one held change go ahead during a change freezePOST /merge-requests/{id}/risk-allow— Accept the risk of a risk-blocked merge requestPOST /merge-requests/{id}/rescan— Run a scan of the merge request againPOST /merge-requests/{id}/resync— Re-read CI and change approval state and process the merge request againPOST /merge-requests/{id}/assign-me— Take the change approvalPOST /merge-requests/{id}/work-items/{key}/reset-usage— Restart a work item's usage count
Projects
GET /projects— List registered projectsGET /projects/search— Search the connection's VCS for repositories to put under change managementGET /projects/by-repo-id/{repo_id}— Get a project by VCS repository IDGET /projects/{id}— Get a projectGET /projects/summary— How many projects the filters match, per connection and modePOST /projects/cm-setup— Put a repository under change management, or set it up againPOST /projects/cm-remove— Take a repository out of change managementGET /projects/cm-status— Whether each agreed setup step is in place, read live from the VCSGET /projects/bulk— The company's recent bulk operationsPOST /projects/bulk— Start a bulk operation on a connection's repositoriesGET /projects/bulk/{op}— A bulk operation and a page of its repositoriesPOST /projects/bulk/{op}/cancel— Cancel a bulk operationPOST /projects/bulk/{op}/retry-failed— Start an operation over another's failed repositoriesPOST /projects/bulk/{op}/revert-done— Move another operation's done repositories backGET /projects/watchable— List the repositories a connection can watchPUT /projects/{id}/mode— Move a project between watching and change managementPUT /projects/{id}/branches— Set the project's target and excluded branchesPUT /projects/{id}/push-ignore— Set the logins whose pushes to the project are not recordedPOST /projects/{id}/unwatch— Stop watching a projectPOST /projects/{id}/forget— Take a repository out of Merge Pilot without touching the VCSPOST /projects/{id}/import-history— Import a watched project's past merge requests againGET /projects/{id}/mode-impact— The open merge requests and what change management would decide for themPUT /projects/{id}/sca-exclude— Set the manifest paths the project's analysis skipsGET /projects/{id}/analysis— The project's latest analysisPOST /projects/{id}/analysis— Analyse the project's default branch nowGET /projects/{id}/analysis/history— The project's analyses, newest firstGET /projects/{id}/analysis/{aid}— One of the project's analysesGET /projects/{id}/analysis/{aid}/details— What an analysis found - dependencies, vulnerabilities, licensesGET /projects/{id}/analysis/{aid}/diff— The vulnerabilities an analysis found new or fixedGET /projects/{id}/sbom— The project's software bill of materialsPUT /projects/{id}/tracker-override— Set the project's own change approval project key, issue type and link typePUT /projects/{id}/vcs-settings— Set the project's own approver rolesPOST /projects/evidence— What was recorded while projects were watchedGET /projects/background— What the company's background work has still to do
Change policies
GET /policy-templates— Built-in policy templatesGET /companies/{id}/policies— List a VCS connection's policies, in orderPOST /companies/{id}/policies— Create a policyPOST /companies/{id}/policies/match— Which policy applies to a described change, and why the ones above it do notGET /companies/{id}/policies/reevaluation— Open merge requests still to be evaluated under changed policiesGET /companies/{id}/policies/warnings— Policies that are never reached, or that match on the diffPOST /companies/{id}/policies/simulate— Evaluate a merge request against the stored or a draft policy setPUT /companies/{id}/policies/reorder— Reorder a connection's policiesPOST /companies/{id}/policies/templates/{key}— Apply a policy template to a connectionPUT /companies/{id}/policies/{policyId}— Update a policyDELETE /companies/{id}/policies/{policyId}— Delete a policyGET /companies/{id}/policies/{policyId}/versions— A policy's saved versions
Approver pools
GET /companies/{id}/approver-pools— List approver poolsPOST /companies/{id}/approver-pools— Create an approver poolPUT /companies/{id}/approver-pools/{poolId}— Update an approver poolDELETE /companies/{id}/approver-pools/{poolId}— Delete an approver poolGET /companies/{id}/approver-pools/{poolId}/versions— A pool's saved versions
Config changes
GET /governance/topics— What waits for a second administrator when control changes are reviewedGET /companies/{id}/config-changes— List control changes waiting for (or decided by) review
Companies
GET /companies/{id}/setup-status— How far the company is set up (the setup checklist)GET /companies— List companiesGET /companies/{id}— Get a companyPUT /companies/{id}— Update company settingsGET /companies/{id}/risk-config/versions— Saved versions of the company's risk settingsGET /companies/{id}/sca-results/{resultId}— Full dependency scan resultGET /companies/{id}/image-scan-results/{resultId}— Full container image scan result
People
GET /users/directory— The company's people (for picking pool members)
Connections
GET /connections— List connectionsPOST /connections— Create a connectionPUT /connections/{id}/vcs-usage— Save a VCS connection's tracker link, approver settings and permissions togetherGET /connections/{id}/cm-steps— What putting a repository under change management writes, for this connectionGET /connections/metadata— Supported providers, deployment types, VCS vocabulary and rolesGET /connections/{id}— Get a connectionPUT /connections/{id}— Update a connectionDELETE /connections/{id}— Delete a connectionPOST /connections/{id}/test— Test a connectionPUT /connections/{id}/link-tracker— Link a tracker to a VCS connectionPUT /connections/{id}/vcs-settings— Set a VCS connection's approver settingsPUT /connections/{id}/vcs-permissions— Set what people may do through a VCS connectionPUT /connections/{id}/tracker-settings— Set a tracker connection's change approval settingsPOST /connections/{id}/tracker-settings/check— Check tracker settings against the trackerGET /connections/{id}/tracker-options— What tracker settings can nameGET /connections/{id}/people-check— Which tracker account each person maps toPOST /connections/{id}/github/manifest— Start registering the connection's GitHub AppPOST /connections/{id}/github/installations/sync— Read the GitHub App's installations againDELETE /connections/{id}/github/app— Forget the connection's GitHub App
VCS operations
GET /vcs-ops/projects/{pid}— Read a repository from the VCSGET /vcs-ops/projects/{pid}/my-access— What the caller may do on a repository, per operationGET /vcs-ops/projects/{pid}/membership— The caller's membership of a repositoryPOST /vcs-ops/projects/{pid}/join— Add the caller to a repositoryPOST /vcs-ops/projects/{pid}/leave— Remove the caller from a repositoryGET /vcs-ops/groups— Groups that hold the company's repositoriesGET /vcs-ops/groups/{gid}/membership— The caller's membership of a groupPOST /vcs-ops/groups/{gid}/join— Add the caller to a groupPOST /vcs-ops/groups/{gid}/leave— Remove the caller from a groupGET /vcs-ops/projects/{pid}/variables— A repository's CI/CD variables and secretsPOST /vcs-ops/projects/{pid}/variables— Create a CI/CD variable or secret on a repositoryPUT /vcs-ops/projects/{pid}/variables/{key}— Change a repository's CI/CD variable or secretDELETE /vcs-ops/projects/{pid}/variables/{key}— Delete a repository's CI/CD variable or secretGET /vcs-ops/projects/{pid}/environments— A repository's deployment environments (GitHub)GET /vcs-ops/projects/{pid}/group— The group (GitHub organization) a repository belongs toGET /vcs-ops/groups/{gid}/variables— A group's CI/CD variables and secretsPOST /vcs-ops/groups/{gid}/variables— Create a CI/CD variable or secret on a groupPUT /vcs-ops/groups/{gid}/variables/{key}— Change a group's CI/CD variable or secretDELETE /vcs-ops/groups/{gid}/variables/{key}— Delete a group's CI/CD variable or secretGET /vcs-ops/projects/{pid}/branches— A repository's branchesGET /vcs-ops/projects/{pid}/protected-branches— A repository's protected branchesPOST /vcs-ops/projects/{pid}/protected-branches— Protect a branchDELETE /vcs-ops/projects/{pid}/protected-branches/{name}— Remove a branch's protectionPATCH /vcs-ops/projects/{pid}/protected-branches/{name}/force-push— Allow or forbid force pushes to a protected branchGET /vcs-ops/projects/{pid}/tokens— Tokens Merge Pilot created on a repository (GitLab)POST /vcs-ops/projects/{pid}/access-tokens— Create a GitLab project access tokenPOST /vcs-ops/projects/{pid}/deploy-tokens— Create a GitLab deploy tokenDELETE /vcs-ops/projects/{pid}/tokens/{token_id}— Revoke a token Merge Pilot createdGET /companies/{id}/vcs-access-grants— Repository and group access people got through Merge PilotDELETE /companies/{id}/vcs-access-grants/{grant_id}— Dismiss a released access recordGET /companies/{id}/vcs-issued-tokens— Released tokens that may still workPOST /companies/{id}/vcs-issued-tokens/{token_id}/revoke— Revoke a released tokenDELETE /companies/{id}/vcs-issued-tokens/{token_id}— Dismiss a released token's record
Tracker
GET /mptracker/projects— List tracker projectsPOST /mptracker/projects— Create a tracker projectGET /mptracker/projects/{id}— Get a tracker projectPUT /mptracker/projects/{id}— Update a tracker projectDELETE /mptracker/projects/{id}— Archive a tracker projectGET /mptracker/projects/{id}/issues— List a project's issuesPOST /mptracker/projects/{id}/issues— Create an issue (manual-mode projects)GET /mptracker/projects/{id}/board— Issues grouped by state (kanban board)GET /mptracker/issues/{id}— Get an issuePUT /mptracker/issues/{id}— Update an issue's summary, description, type or custom fieldsGET /mptracker/issues/by-key/{key}— Get an issue by key (e.g. a change approval key)POST /mptracker/issues/{id}/transition— Move an issue to another statePOST /mptracker/issues/{id}/assign— Assign an issueGET /mptracker/issues/{id}/comments— List an issue's commentsPOST /mptracker/issues/{id}/comments— Comment on an issueGET /mptracker/users— Search the company's active users by prefix (for assignee pickers)
Audit
GET /audit-logs— Search the audit logGET /webhook-logs— Inbound webhook log (VCS and tracker events received)GET /compliance/report— Export the compliance report (CSV or PDF)
Insights
GET /companies/{id}/vulnerabilities— The vulnerability inventory of the company's default branchesGET /companies/{id}/vulnerabilities/feeds— When the CISA KEV and FIRST EPSS feeds were last readGET /companies/{id}/vulnerabilities/summary— The inventory at a glanceGET /companies/{id}/vulnerabilities.csv— The filtered inventory as CSVGET /companies/{id}/direct-changes— Changes made to watched branches without a merge requestGET /companies/{id}/direct-changes/summary— The last 30 days' direct changes at a glanceGET /companies/{id}/direct-changes.csv— The filtered direct changes as CSVGET /companies/{id}/iac-findings— The infrastructure findings of the company's default branchesGET /companies/{id}/iac-findings/summary— The infrastructure inventory at a glanceGET /companies/{id}/vulnerability-exceptions— The company's vulnerability exceptionsPOST /companies/{id}/vulnerability-exceptions— Accept an advisory, or mark it not affectingDELETE /companies/{id}/vulnerability-exceptions/{eid}— Revoke an exceptionGET /companies/{id}/monitoring/report— What change management would have done with watched repositories' merge requestsPOST /companies/{id}/monitoring/report— The monitoring report with a draft policy setGET /companies/{id}/monitoring/report.csv— The monitoring report's merge requests as CSVGET /dashboard— Dashboard overviewGET /dashboard/stats— Dashboard countersGET /dashboard/cycle-time— Cycle time summaryGET /dashboard/change-calendar— Changes per day of a monthGET /dora— DORA metricsGET /analytics/cycle-time— Cycle time analyticsGET /analytics/bottlenecks— Where merge requests waitGET /my-work— The caller's open work (authored MRs, change approvals to decide)
Delegations
GET /delegations— Current and future delegationsPOST /delegations— Hand an approver's votes to someone else for a whileGET /delegations/people— People who can be chosen as delegateDELETE /delegations/{id}— End a delegation
Notification deliveries
GET /companies/{id}/notification-deliveries— The delivery logGET /companies/{id}/notification-deliveries/failures— Deliveries that failed for goodPOST /companies/{id}/notification-deliveries/{did}/redeliver— Send a delivery again nowGET /companies/{id}/notification-routes/inactive-recipients— Route addresses of deactivated people
Notifications
GET /auth/me/notification-preferences— Own personal notification emailsPUT /auth/me/notification-preferences— Turn personal notification emails on or offGET /notifications/unsubscribe— Open an unsubscribe link (redirect)POST /notifications/unsubscribe— Unsubscribe (one click)GET /notifications/unsubscribe/details— What an unsubscribe link turns off
Jobs
GET /jobs— List background jobsGET /jobs/stats— Job counts by statusGET /jobs/{id}— Get a jobPOST /jobs/{id}/retry— Queue a job again
Health
GET /health-checks— Recorded health checks of the services Merge Pilot callsGET /health-checks/summary— Latest state per connectionGET /health-checks/notifications— Companies with failed notification deliveriesGET /scanner/rules— Secret scanner rulesGET /healthz— Liveness probe (outside /api/v1)GET /readyz— Readiness probe (outside /api/v1)GET /version— The running releaseGET /instances— The running instances
Platform
GET /settings/urls— The addresses Merge Pilot is reached atGET /license/status— License state (any signed-in account)
Diagnostics
GET /debug/mr/{id}/flow— A merge request's event flowPOST /debug/webhooks/{id}/replay— Replay a received webhookGET /api-calls— Calls Merge Pilot made to the VCS and the tracker