curl --request POST \
--url https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_head_sha": "<string>",
"expected_pr_number": 2,
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delete_branch": true
}
'import requests
url = "https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge"
payload = {
"expected_head_sha": "<string>",
"expected_pr_number": 2,
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delete_branch": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_head_sha: '<string>',
expected_pr_number: 2,
idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
delete_branch: true
})
};
fetch('https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expected_head_sha' => '<string>',
'expected_pr_number' => 2,
'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'delete_branch' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge"
payload := strings.NewReader("{\n \"expected_head_sha\": \"<string>\",\n \"expected_pr_number\": 2,\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delete_branch\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_head_sha\": \"<string>\",\n \"expected_pr_number\": 2,\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delete_branch\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_head_sha\": \"<string>\",\n \"expected_pr_number\": 2,\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delete_branch\": true\n}"
response = http.request(request)
puts response.read_body{
"checks": [
{
"check_run_id": 4503599627370495,
"name": "<string>",
"status": "<string>",
"summary_truncated": true,
"completed_at": "2023-11-07T05:31:56Z",
"conclusion": "<string>",
"details_url": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"summary": "<string>"
}
],
"merge_box": {
"additions": 1,
"author_login": "<string>",
"checks_failed": 1,
"checks_passed": 1,
"checks_total": 1,
"commits": 1,
"deletions": 1,
"draft": true,
"head_is_fork": true,
"head_sha": "<string>",
"html_url": "<string>",
"pr_number": 2,
"ready_for_merge": true,
"title": "<string>",
"base_branch": "<string>",
"base_sha": "<string>",
"ci_status": "pending",
"head_branch": "<string>",
"mergeable_state": "clean",
"merged_at": "2023-11-07T05:31:56Z",
"stack_children": [
{
"html_url": "<string>",
"pr_number": 2,
"pull_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "open",
"title": "<string>"
}
],
"stack_parent": {
"html_url": "<string>",
"pr_number": 2,
"pull_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "open",
"title": "<string>"
},
"state": "open"
},
"reviewers": [
{
"decision": "approved",
"is_bot": true,
"kind": "user",
"login": "<string>"
}
],
"reviews": [
{
"author_is_bot": true,
"author_login": "<string>",
"body": "<string>",
"github_review_id": 4503599627370496,
"html_url": "<string>",
"state": "<string>",
"submitted_at": "2023-11-07T05:31:56Z"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}Merge a pull request
Merges the pull request with the chosen method, pinned to the expected_head_sha and expected_pr_number the caller confirmed, deleting the head branch afterwards when asked and while it still points at the merged head, and answers with the GitHubPullRequest read after the merge; the idempotency key is the caller’s and claimed before GitHub is called, so a completed merge is not made twice. A member with a product role in an owning organization of the pull request who holds push permission on its repository may call it. A caller without push is refused with 403 github_push_access_required, delete_branch on a fork’s branch with 422 fork_branch_delete_unsupported, a method the repository disallows with GitHub’s 422, a moved head or a branch a push moved with 409 head_moved, and a key whose first attempt failed with 409 idempotency_key_conflict. A pull request that does not exist, one no organization of the caller owns and one whose GitHub access the caller has lost answer the same 404, and omitting org_id while more than one of the caller’s organizations owns it is a 422 org_id_required.
curl --request POST \
--url https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expected_head_sha": "<string>",
"expected_pr_number": 2,
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delete_branch": true
}
'import requests
url = "https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge"
payload = {
"expected_head_sha": "<string>",
"expected_pr_number": 2,
"idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delete_branch": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
expected_head_sha: '<string>',
expected_pr_number: 2,
idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
delete_branch: true
})
};
fetch('https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'expected_head_sha' => '<string>',
'expected_pr_number' => 2,
'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'delete_branch' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge"
payload := strings.NewReader("{\n \"expected_head_sha\": \"<string>\",\n \"expected_pr_number\": 2,\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delete_branch\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expected_head_sha\": \"<string>\",\n \"expected_pr_number\": 2,\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delete_branch\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.runaether.dev/pull-requests/{pullRequestID}/github/merge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expected_head_sha\": \"<string>\",\n \"expected_pr_number\": 2,\n \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"delete_branch\": true\n}"
response = http.request(request)
puts response.read_body{
"checks": [
{
"check_run_id": 4503599627370495,
"name": "<string>",
"status": "<string>",
"summary_truncated": true,
"completed_at": "2023-11-07T05:31:56Z",
"conclusion": "<string>",
"details_url": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"summary": "<string>"
}
],
"merge_box": {
"additions": 1,
"author_login": "<string>",
"checks_failed": 1,
"checks_passed": 1,
"checks_total": 1,
"commits": 1,
"deletions": 1,
"draft": true,
"head_is_fork": true,
"head_sha": "<string>",
"html_url": "<string>",
"pr_number": 2,
"ready_for_merge": true,
"title": "<string>",
"base_branch": "<string>",
"base_sha": "<string>",
"ci_status": "pending",
"head_branch": "<string>",
"mergeable_state": "clean",
"merged_at": "2023-11-07T05:31:56Z",
"stack_children": [
{
"html_url": "<string>",
"pr_number": 2,
"pull_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "open",
"title": "<string>"
}
],
"stack_parent": {
"html_url": "<string>",
"pr_number": 2,
"pull_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"state": "open",
"title": "<string>"
},
"state": "open"
},
"reviewers": [
{
"decision": "approved",
"is_bot": true,
"kind": "user",
"login": "<string>"
}
],
"reviews": [
{
"author_is_bot": true,
"author_login": "<string>",
"body": "<string>",
"github_review_id": 4503599627370496,
"html_url": "<string>",
"state": "<string>",
"submitted_at": "2023-11-07T05:31:56Z"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}{
"code": "account_deleting",
"error": "<string>",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
The pull request's owning organization to act in: the org_id the PullRequest carries. Required when more than one of the caller's organizations owns the pull request.
Body
the exact 40-character lowercase head commit SHA the user reviewed; GitHub refuses the merge if the PR head has moved past it
40^[0-9a-f]{40}$the number of the pull request the user reviewed; the merge is refused with 409 if the task's primary published pull request is no longer this one
x >= 1client-generated stable key for this merge; a retry with the same key replays the first result without merging again
GitHub's merge method: squash, rebase, or merge (a merge commit). A method the repository's settings disallow is refused with 422 carrying GitHub's message.
squash, rebase, merge True: delete the head branch once the merge succeeds, and only while it still points at the merged head; a branch a push moved is kept and answered with 409 naming the merge commit. Refused with 422 fork_branch_delete_unsupported before merging when the head branch lives in a fork. False or omitted: the branch stays.