# Start or end CI failover

> Start (on: true) or end (on: false) CI failover on a mirror standing by: the remote keeps the code, and g1t runs its workflows, .github/workflows as well as .g1t/workflows, on each push copied in.

<div class="g1t-endpoint"><span class="g1t-method" data-method="post">POST</span><code>/repos/{owner}/{name}/mirror/ci</code></div>

Workflows that deploy wait for approval unless the link's settings say otherwise. Needs the Admin role.

- **Authentication:** Required. Send an [access token](/reference/api/#authentication) as `Authorization: Bearer`.
- **MCP tool:** [`repository`](/reference/mcp/#repository) with `action` `mirror_ci`, and the same inputs
- **Scope:** An access token needs [`repo:admin`](/guides/authentication/#scopes).

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `owner` | string | Yes | The workspace that owns the repository. |
| `name` | string | Yes | The repository's name. |

## Body parameters

Send a JSON object. Names are `snake_case`, as in responses; the `camelCase` spelling is accepted too.

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `on` | boolean | Yes | True to start CI failover, false to end it. |

## Example request

```sh
curl -X POST https://api.g1t.sh/repos/acme/web/mirror/ci \
  -H "Authorization: Bearer $G1T_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "on": true
  }'
```

## Example response

A successful request answers `200` with:

```json
{
  "remotes": [
    {
      "id": "rmt_01kp4a2b3c4d5e6f7g8h9j0k1m",
      "repo_id": "rep_01kp49z8y7x6w5v4t3s2r1q0pn",
      "repo": "acme/web",
      "provider": "github",
      "role": "leader",
      "name": "github.com/acme/web",
      "url": "https://github.com/acme/web",
      "state": "ci",
      "state_since": "2026-10-08T13:58:00.000Z",
      "state_by": "syntaqx",
      "reachable": true,
      "unreachable_since": null,
      "synced_at": "2026-10-08T13:57:42.000Z",
      "last_error": null,
      "checks_problem": null,
      "settings": {
        "notify": "banner",
        "take_over_after": null,
        "hand_back": "when_clean",
        "keep_ci_warm": false,
        "github_workflows": true,
        "hold_deploys": true,
        "report_checks": true,
        "remote_pushes": "adopt"
      },
      "created_at": "2026-10-05T10:00:00.000Z"
    }
  ],
  "plan": null,
  "can_manage": true
}
```

## Errors

A failed request answers with one of these statuses and a body like `{"error": {"code": "not_found", "message": "Repository not found."}}`. See [errors](/reference/api/#errors).

| Status | Code | When |
| --- | --- | --- |
| 401 | `unauthenticated` | A token is required, or the one sent is not valid. |
| 403 | `forbidden` | The token is valid but not allowed to do this, such as a member-only change or an agent token outside its repository. |
| 404 | `not_found` | It does not exist, or you cannot see it. |
| 409 | `conflict` | The request conflicts with the current state. |
| 422 | `invalid` | The input is not valid. `message` says which field and why. |