Sample - GitHub REST API
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 merge is still queued, the response includes the UUID, merge method, and expected head SHA of the request. Once the merge has completed, the response reports whether it was merged, including the merge commit OID on success or a message describing why it could not be merged on failure.

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.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

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 an asynchronous merge request was created or already existed
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.