simulator

Get a Mergify configuration simulation for a repository

Changed on

Get a simulation of what Mergify will do for this repository

post/repos/{owner}/{repository}/configuration-simulator

Request

  • Base URL: https://api.mergify.com/v1
  • URL: https://api.mergify.com/v1/repos/{owner}/{repository}/configuration-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

Request body

mergify_ymlstring required

A Mergify configuration

Response

Successful Response

messagestring required

The message of the Mergify check run simulation

Changes