Updating a Pipeline Group
Function
Updating a Pipeline Group
URI
POST /v5/{project_id}/api/pipeline-group/update
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header). |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| name | Yes | String | Pipeline Group Name |
| id | Yes | String | Pipeline Group ID |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Whether the operation is successful |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_msg | String | Error Message |
| error_code | String | Error code. |
Example Requests
Change the group name to New Group 2.
POST https://{endpoint}/v5/d80a8a6530324b7bac972cbb8a9f28ec/api/pipeline-group/update
{
"name" : "Creating group 2",
"id" : "1d0ae9894c8549a88931539d1959c571"
} Example Responses
Status code: 200
OK
{
"success" : true
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
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.
