Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Creating a Parameter Group
Updated on 2025-09-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Parameter Group

Function

This API is used to create a parameter group.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipeline/variable/group/create

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. 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

name

Yes

String

Definition:

Parameter group name.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

description

No

String

Definition:

Description details.

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
Table 3 variables

Parameter

Mandatory

Type

Description

sequence

No

Integer

Definition:

Sequence number of a parameter.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

name

No

String

Definition:

Parameter name.

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

description

No

String

Definition:

Parameter description.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

is_secret

No

Boolean

Definition:

Private parameter or not.

Constraints:

N/A

Value range:

  • true: The parameter is private.

  • false: The parameter is not private.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

pipeline_variable_group_id

String

Definition:

Parameter group ID.

Value range:

The value consists of 32 characters, including digits and letters.

Example Requests

POST https://(endpoint)/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipeline/variable/group/create

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

Example Responses

Status code: 200

Response body.

{
  "pipeline_variable_group_id" : "66d40ba4e3da4505aaaf7e9de9860b6e"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.

Parent Topic: Pipeline Management