Starting Repository Image Synchronization

This API is used to start repository image synchronization.

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

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. Value range: 1~2147483647

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. 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

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.

Start repository image synchronization

POST /v4/repositories/123/remote-mirror

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

Status code: 200

{
  "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"
}

Parent topic: Repository

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.