Skip to content

Query the list of push remote mirrors for a repository

GET /api/v5/repos/{owner}/{repo}/push_remote_mirrors

Query the list of push remote mirrors for the specified repository.

Access token support

  • AtomGit user access tokens

Anonymous access

This endpoint does not allow anonymous access.

Request parameters

Parameter Location Type Required Description
owner path string Yes Address of the namespace that owns the repository (the address path of the enterprise, organization, or personal namespace)
repo path string Yes Repository path (path)
access_token query string Yes User authorization code

Response parameters

Field Type Always returned Nullable Description
(response body) array Yes No List of remote mirrors; each array element is a remote mirror object

Remote mirror object

Field Type Always returned Nullable Description
id integer — — Mirror ID
project_id integer — — Repository ID
update_status string — — Update status
last_update_at string — — Last update time
url string — — Remote mirror URL
last_successful_update_at string — — Last successful update time
number_of_failures integer — — Number of consecutive failures
is_private boolean — — Whether the repository is private
message string — — Message from the most recent update
force boolean — — Whether to force push
created_at string — — Creation time

Error response

This endpoint does not provide an error response example; the actual error response fields depend on what the backend returns.

HTTP response status codes

Status code Description
200 Succeeded (OK)
401 Authentication required (Requires authentication)
403 Access forbidden (Forbidden)
404 The requested resource does not exist (Not found)
429 Too many requests; rate limit triggered
500 Internal system error

Request example

Parameter notes

Replace <owner> with the address of the namespace that owns the repository (the address path of the enterprise, organization, or personal namespace); replace <repo> with the repository path (path); replace <token> with your AtomGit user access token.

cURL

curl -X GET 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_remote_mirrors?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript

// Native fetch (Node.js 18+ / browser)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_remote_mirrors?access_token=<token>",
  {
    headers: {
      "Accept": "application/json",
    },
  },
);

if (!response.ok) {
  throw new Error(`Request failed: ${response.status}`);
}

const data = await response.json();
console.log(data);

Python

import requests

resp = requests.get(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/push_remote_mirrors",
    params={"access_token": "<token>"},
    headers={"Accept": "application/json"},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

Response example

Status code: 200

[
  {
    "id": 1,
    "project_id": 100,
    "update_status": "success",
    "last_update_at": "2026-10-12T09:30:00Z",
    "url": "https://api.atomgit.com/example/repo.git",
    "last_successful_update_at": "2026-10-12T09:30:00Z",
    "number_of_failures": 0,
    "is_private": true,
    "message": "",
    "force": true,
    "created_at": "2026-01-01T00:00:00Z"
  }
]

Error codes

Error code Description
401 Unauthenticated or invalid credentials (missing or invalid access credentials)
403 Insufficient permissions; access forbidden
404 The requested resource does not exist
429 Too many requests; rate limit triggered
500 Internal system error

Markdown source: View on AtomGit·Content from the open-source project gitcode-dev/atomgit-api-doc