Editing a Parameter Group

Function

This API is used to edit a parameter group.

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	Project ID.
name	Yes	String	Parameter group name.
description	No	String	Description.
variables	No	Array of variables objects	Parameter list.
id	Yes	String	Parameter group ID.

**Table 3** variables
Parameter	Mandatory	Type	Description
name	No	String	Parameter name.
sequence	No	Integer	Parameter No.
type	No	String	Parameter type.
value	No	String	Default parameter value.
is_secret	No	Boolean	Whether the parameter is private or not.
description	No	String	Description.

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