---
title: "Get a Mergify simulation for a repository"
method: POST
path: "/repos/{owner}/{repository}/simulator"
tags: ["simulator"]
---

# Get a Mergify simulation for a repository

`POST /repos/{owner}/{repository}/simulator`

Get a simulation of what Mergify will do for this repository

## Path parameters

- `owner` string, required — The owner of the repository
- `repository` string, required — The name of the repository

## Request body

- SimulatorPayload
  - `mergify_yml` string, required — A Mergify configuration

## Response `200`

Successful Response

- SimulatorResponse
  - `title` string, required — The title of the Mergify check run simulation
  - `summary` string, required — The summary of the Mergify check run simulation
  - `deprecations` DeprecationInfo[], required — Deprecation notices detected in the configuration
    - `message` string, required — Human-readable deprecation reason
    - `deadline` string, date, required — Date after which the deprecated configuration will be rejected
    - `path_to_field` string[], nullable, required — Path to the deprecated field inside the configuration, or null when the deprecation is not tied to a specific field

## Other responses

- `403` — Forbidden
- `404` — Not found
- `409` — Conflict
- `422` — Unprocessable entity

---

[API](https://skmtc.net/mergify/apis/mergify-api.md) · [All operations](https://skmtc.net/mergify/apis/mergify-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mergify/mergify-api/revisions/ae394a06c465/schema)