Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Repository/ Starting Repository Image Synchronization
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Starting Repository Image Synchronization

Function

This API is used to start repository image synchronization.

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

POST 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

username

No

String

Definition:

Username (Base64 encoding required)

Constraints:

N/A

Value range:

N/A

Default value:

N/A

password

No

String

Definition:

Password (Base64 encoding required)

Constraints:

N/A

Value range:

N/A

Default value:

N/A

endpoint_uuid

No

String

Definition:

Endpoint UUID

Constraints:

N/A

Value range:

N/A

Default value:

N/A

force_fetch

No

Boolean

Definition:

Force sync

Constraints:

N/A

Value range:

  • true: forcible sync

  • false: non-forcible synchronization

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

jid

String

Definition

Synchronization task ID.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

Start repository image synchronization

POST /v4/repositories/123/remote-mirror

{
  "username" : "",
  "password" : "",
  "endpoint_uuid" : ""
}

Example Responses

Status code: 200

OK

{
  "jid" : "09a56216-cb37-494c-b314-d88dc6c9ff57"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permission and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.004404",
  "error_msg" : "Repository Not Found"
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Repository