simulator

Get a Mergify simulation for a repository

Changed on

Get a simulation of what Mergify will do for this repository

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

Request

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

titlestring required

The title of the Mergify check run simulation

summarystring required

The summary of the Mergify check run simulation

Changes

  • b3864dcc206aRevision changes
    • info

      the endpoint scheme security MergifyTokenBearerAuth was added to the API

  • 29857c6146cfRevision changes
    • info

      the endpoint scheme security AdminApplicationKey was added to the API

    • info

      the endpoint scheme security ApplicationAuth was removed from the API