Sign in
simulator

Get a Mergify simulation for a pull request

Get a simulation of what Mergify will do on a pull request

post/repos/{owner}/{repository}/pulls/{number}/simulator

Path parameters

ownerstring required

The owner of the repository

The owner of the repository

repositorystring required

The name of the repository

The name of the repository

numberinteger required

The pull request number

The pull request number

Request body

mergify_ymlstring required

A Mergify configuration

Response

Successful Response

titlestring required

The title of the Mergify check run simulation

summarystring required

The summary of the Mergify check run simulation

Changes

Changed in 2 of the 9 revisions of this API.3

  • b3864dcc206a1See the full diff
    • ○

      the endpoint scheme security MergifyTokenBearerAuth was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 29857c6146cf2See the full diff
    • ○

      the endpoint scheme security AdminApplicationKey was added to the API

      api-security-added

    • ○

      the endpoint scheme security ApplicationAuth was removed from the API

      api-security-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog