Git mirrors

Pause, resume, or sync a Git mirror

Applies the path action when expectedVersion matches. requestId makes retries idempotent; 202 returns an admission receipt, and pause has no job ID. Requires authenticated authority and enforces current resource policy.

post/api/repos/{owner}/{repo}/mirrors/{mirror}/{action}

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: repo:metadata:write, repo:contents:write

Path parameters

ownerstring required
repostring required
mirrorstring required
action'pause' | 'resume' | 'sync' required

Request body

expectedVersioninteger required
requestIdstring uuid required

Response

Response for status 202

jobIdstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.