Editing a Parameter Group

Function

This API is used to modify a parameter group based on its details.

Calling Method

For details, see Calling APIs.

URI

PUT /v5/{project_id}/api/pipeline/variable/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 body parameters
Parameter	Mandatory	Type	Description
projectId	Yes	String	Definition: Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A
name	Yes	String	Definition: Parameter group name. Constraints: N/A Value range: N/A Default value: N/A
description	No	String	Definition: Description. Constraints: N/A Value range: N/A Default value: N/A
variables	No	Array of variables objects	Definition: Parameter list. Constraints: N/A Value range: N/A Default value: N/A
id	Yes	String	Definition: Parameter group ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

**Table 3** variables
Parameter	Mandatory	Type	Description
name	No	String	Definition: Parameter name. Constraints: N/A Value range: N/A Default value: N/A
sequence	No	Integer	Definition: Sequence number of a parameter. Constraints: N/A Value range: N/A Default value: N/A
type	No	String	Definition: Parameter type. Constraints: N/A Value range: N/A Default value: N/A
value	No	String	Definition: Default parameter value. Constraints: N/A Value range: N/A Default value: N/A
is_secret	No	Boolean	Definition: Whether the parameter is private. Constraints: N/A Value range: true: The parameter is private. false: The parameter is not private. Default value: N/A
description	No	String	Definition: Description. 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.

Example Requests

PUT https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/update

{
  "projectId" : "e2e18230a85d4d6ab0b56cb6d2246c18",
  "name" : "2131",
  "description" : "",
  "variables" : [ {
    "name" : "123",
    "sequence" : 1,
    "type" : "string",
    "value" : "123",
    "is_secret" : false,
    "description" : "123"
  } ],
  "id" : "66d40ba4e3da4505aaaf7e9de9860b6e"
}