Cherry-Picking a Merge Request
Function
This API is used to cherry pick a merge request.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST https://{hostURL}/v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/cherry-pick
| 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 |
| merge_request_iid | Yes | Integer | Definition MR internal ID (IID). Value range: 1~2147483647 |
Request 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. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| branch | Yes | String | Branch name |
| with_new_merge_request | No | Boolean | Whether to cherry pick or revert MRs through creating MRs |
| message | No | String | Commit message |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| state | String | Cherry pick result |
| title | String | Cherry pick title |
| cherry_pick_branch_name | String | Cherry pick temporary branch name |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Example Requests
POST /v4/repositories/2661032/merge-requests/1/cherry-pick
{
"branch" : "test",
"with_new_merge_request" : true,
"message" : "Commit message"
} Example Responses
Status code: 200
OK
{
"state" : "success",
"title" : "Cherry pick",
"cherry_pick_branch_name" : "cherry-pick-commit-ff660328-1758540992382-auto"
} Status code: 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "Authentication information expired."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
