---
title: "Reconfigure a Git mirror"
method: PUT
path: "/api/repos/{owner}/{repo}/mirrors/{mirror}"
tags: ["Git mirrors"]
---

# Reconfigure a Git mirror

`PUT /api/repos/{owner}/{repo}/mirrors/{mirror}`

## Request

- Base URL: `https://git.cafe`
- URL: `https://git.cafe/api/repos/{owner}/{repo}/mirrors/{mirror}`
- Auth: one of:
  - API key in cookie `gc-session`
  - HTTP bearer
  - HTTP basic
  - HTTP token
  - OAuth 2
    - Authorization code: `/api/oauth/authorize`
    - Token URL: `/api/oauth/token` scopes: `repo:metadata:write`, `repo:contents:write`

Replaces mirror configuration when expectedVersion matches and queues a sync. Reusing requestId with the same input returns the prior receipt; 202 does not mean the sync completed. Requires authenticated authority and enforces current resource policy.

## Path parameters

- `owner` string, required
- `repo` string, required
- `mirror` string, required

## Request body

- object
  - `requestId` string, uuid, required
  - `expectedVersion` integer, required
  - `url` string, required
  - `localRef` string, required
  - `remoteRef` string, required
  - `direction` 'push' | 'pull' | 'bidirectional', required
  - `conflictWinner` 'gitcafe' | 'remote'
  - `intervalMinutes` integer
  - `maxPackBytes` integer
  - `auth` union
    - object
      - `type` 'none', required
    - object
      - `type` 'basic', required
      - `username` string, required
      - `password` string, required

## Response `202`

Response for status 202

- object
  - `mirror` object, required
    - `id` string, required
    - `version` integer, required
    - `url` string, required
    - `localRef` string, required
    - `remoteRef` string, required
    - `direction` 'push' | 'pull' | 'bidirectional', required
    - `conflictWinner` 'gitcafe' | 'remote', required
    - `intervalMinutes` integer, required
    - `maxPackBytes` integer, required
    - `authenticated` boolean, required
    - `state` 'active' | 'paused', required
    - `commonOid` string, nullable, required
    - `lastSyncedAt` string, nullable, required
    - `lastError` string, nullable, required
    - `job` object, nullable, required
      - `id` string, required
      - `state` 'queued' | 'running' | 'succeeded' | 'blocked' | 'failed', required
      - `effectPermitted` boolean, required
      - `reconciliationRequired` boolean, required
      - `error` string, nullable, required
  - `jobId` string, nullable, required

## Other responses

- `400`: The request is invalid.
- `401`: Authentication is required, or the supplied credential is invalid.
- `403`: The credential does not permit this operation. A `code`, when present, names the refusal.
- `404`: The resource does not exist or is not visible to the caller.
- `409`: The request conflicts with the current state. A `code`, when present, names the refusal; `retryable` says whether the same request can succeed later, and `operationId` names the operation in the way.
- `429`: A rate limit is exhausted. Wait Retry-After seconds; the value is a hint, so back off on a repeat 429.
- `503`: A required service is temporarily unavailable; retry later.

---

[API](https://skmtc.dev/gitcafe/apis/git-cafe-api.md) - [All operations](https://skmtc.dev/gitcafe/apis/git-cafe-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitcafe/apis/git-cafe-api/revisions/9fa233d2986d?raw)