Help Center/ CodeArts Pipeline/ API Reference/ API/ Manage by group/ Updating a Pipeline Group

Updated on 2023-11-28 GMT+08:00

View PDF

Updating a Pipeline Group

Function

URI

POST /v5/{project_id}/api/pipeline-group/update

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header 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).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Pipeline Group Name
id	Yes	String	Pipeline Group ID

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
success	Boolean	Whether the operation is successful

Status code: 400

**Table 5** Response body parameters
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"
}