Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Updating Repository Mirror Information

Updated on 2026-01-27 GMT+08:00

View PDF

Updating Repository Mirror Information

Function

This API is used to update repository mirror information.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
codeartsrepo:repository:setRepository	Write	-	-	-	-

URI

PUT https://{hostURL}/v4/repositories/{repository_id}/remote-mirror

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Definition You can query the project list to obtain the repository ID by calling the API used to query user's all repositories. Constraints N/A Default Value N/A Value range: 1~2147483647

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token. Constraints N/A Range 1–100,000 characters. Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
url	No	String	Definition: Source repository address. Value range: N/A Constraints: Start with http:// or https:// Default value: N/A
sync_branch_type	No	String	Definition: Branch synchronization Value range: all: synchronize all branches. default: synchronize the default branch. Constraints: N/A Default value: N/A Enumeration values: all default
mirroring_enabled	No	Boolean	Definition: Enable scheduled synchronization Value range: true: scheduled synchronization is disabled. false: scheduled synchronization is enabled. Constraints: N/A Default value: N/A
endpoint_uuid	No	String	Definition: UUID of a branch point Value range: N/A Constraints: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
url	String	Definition: Source repository address Constraints: N/A
mirroring_enabled	Boolean	Definition: Enable scheduled synchronization Value range: true: scheduled synchronization is disabled. false: scheduled synchronization is enabled. Constraints: N/A
endpoint_uuid	String	Definition: UUID of a branch point Constraints: N/A
sync_branch_type	String	Definition: Branch synchronization Value range: all: synchronize all branches. default: synchronize the default branch. Constraints: N/A Enumeration values: all default

Example Requests

Update repository mirror information

PUT /v4/repositories/{repository_id}/remote-mirror

{
  "url" : "https://gitee.com/mars167/git-flow-test.git",
  "sync_branch_type" : "all",
  "mirroring_enabled" : true,
  "endpoint_uuid" : "dd19c11ea8464520bc8de7cbdf4418a8"
}

Example Responses

Status code: 200

{
  "url" : "https://gitee.com/mars167/git-flow-test.git",
  "mirroring_enabled" : true,
  "endpoint_uuid" : "dd19c11ea8464520bc8de7cbdf4418a8",
  "sync_branch_type" : "all"
}