pulls

Get the result of an asynchronous merge

Changed on

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.

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

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/merge-async/{uuid}
  • Auth: none declared

Path parameters

ownerstring required

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

repostring required

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

pull_numberinteger required

The number that identifies the pull request.

uuidstring required

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

Response

the current result of the asynchronous merge request

status'pending' | 'merged' | 'enqueued' | 'failed' required

Changes

  • f3786094214cRevision changes
    • info

      added the optional property // to the response with the status

  • 0e3af192d558Revision changes
    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 to the response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the response property oneOf list for the response status