DeleteVariableGroup - Delete variable group

Updated at:

Delete a variable group using OpenAPI.

Applicable editions

Central edition, Region edition

Endpoints and authorization information

  • Obtain endpoints: Replace {domain} in the API request syntax.
  • Obtain a personal access token.
  • Obtain the organizationId: Required only for the Central edition. Find the organization ID on the Basic Information page of the Organization Management console.

Product

Resource

Required permissions

Pipeline

Variable group

Read/write

Request syntax

Central edition

DELETE https://{domain}/oapi/v1/flow/organizations/{organizationId}/variableGroups/{id}

Region edition

DELETE https://{domain}/oapi/v1/flow/variableGroups/{id}

Request headers

Parameter

Type

Required

Description

Example value

x-yunxiao-token

string

Yes

Personal access token.

pt-0fh3****0fbG_35af****0484

Request parameters

Parameter

Type

Location

Required

Description

Example value

organizationId

string

path

  • Yes: Central edition

  • No: Region edition

Organization ID.

5ebbc0228123212b59xxxxx

id

integer

path

Yes

Variable group ID.

123

Request examples

Central edition

curl -X 'DELETE' \
  'https://{domain}/oapi/v1/flow/organizations/5ebbc0228123212b59xxxxx/variableGroups/123' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region edition

curl -X 'DELETE' \
  'https://{domain}/oapi/v1/flow/variableGroups/123' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Response parameters

Parameter

Type

Description

Example value

-

boolean

Whether the operation succeeded.

true

Response example

true

Error codes

For API error codes, see the Error Code Center.