remote_mirrors

List all remote mirrors for a project

Lists all remote mirrors for a specified project.

get/api/v4/projects/{id}/remote_mirrors

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idstring required

The ID or URL-encoded path of the project

Query parameters

pageinteger

Current page number

per_pageinteger

Number of items per page

Response

List all remote mirrors for a project

idinteger required
enabledboolean required
urlstring required
update_statusstring required
last_update_atstring date-time required
last_update_started_atstring date-time required
last_successful_update_atstring date-time required
last_errorstring required
only_protected_branchesboolean required
keep_divergent_refsboolean required
auth_methodstring required
mirror_branch_regexstring required

Example response

[
  {
    "id": 101486,
    "enabled": true,
    "url": "https://*****:*****@example.com/gitlab/example.git",
    "update_status": "finished",
    "last_update_at": "2020-01-06T17:32:02.823Z",
    "last_update_started_at": "2020-01-06T17:32:02.823Z",
    "last_successful_update_at": "2020-01-06T17:31:55.864Z",
    "last_error": "The remote mirror URL is invalid.",
    "auth_method": "password",
    "host_keys": [
      {
        "fingerprint_sha256": "SHA256:abcd1234"
      }
    ],
    "mirror_branch_regex": "feature-.*"
  }
]

Changes

No recorded changes to this operation across all 5 revisions of this API.