simulator

Get a Mergify simulation for a pull request

Changed on

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

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

Request

  • Base URL: https://api.mergify.com/v1
  • URL: https://api.mergify.com/v1/repos/{owner}/{repository}/pulls/{number}/simulator
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

repositorystring required

The name of the repository

ownerstring required

The owner of the repository

numberinteger required

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