GET/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}

Get the result of an asynchronous merge

Fetches the current result of an asynchronous merge request, identified by the UUID that was returned when the merge was requested.

While the request's status is pending, the response includes the UUID, merge method, merge action, and expected head SHA of the request. Once the asynchronous request completes, its status is one of:

merged: The pull request was merged into the base branch. The response includes the merge commit OID.
enqueued: The pull request was added to a merge queue.
failed: The request failed. The response includes a message describing the failure.

An enqueued result is final for the merge queue requests and does not mean the pull request has merged. This result does not change when the merge queue later merges the pull request. To get the eventual merge status, check if a pull request has been merged.

The result of an asynchronous merge request is retained for 24 hours after its most recent update. After this window the request expires and this endpoint returns a 404 response for its UUID.

4 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

pull_numberintegerrequired

The number that identifies the pull request.

uuidstringrequired

The UUID of the asynchronous merge request, as returned when the merge was requested.

3 status codes

200the current result of the asynchronous merge request

statusstringrequired

Allowed:pendingmergedenqueuedfailed

detailsobjectrequired

When the asynchronous merge request is pending

403Forbidden

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 403 is returned: Forbidden. A 404 is returned: Resource not found.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.mergeAsync.get({
  owner: "octocat",
  repo: "hello-world",
  pullNumber: "example",
  uuid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "status": "pending",
  "details": {
    "message": "Merge request is in progress.",
    "uuid": "630b9d5e-3f2a-4f7e-8b0c-2d5f9a8c1e42",
    "merge_method": "merge",
    "merge_action": "default",
    "expected_head_sha": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
    "bypass_rules": false
  }
}

Request

Response

Errors