Updating a Pipeline Group

Function

This API is used to update a pipeline group.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for . Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition: Pipeline group name. Constraints: N/A Value range: N/A Default value: N/A
id	Yes	String	Definition: Pipeline group ID. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
success	Boolean	Definition: Whether the operation is successful. Value range: true: The operation is successful. false: The operation fails.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

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