Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Updating Pipeline Resource-Level Permissions Status
Updated on 2025-09-08 GMT+08:00

Updating Pipeline Resource-Level Permissions Status

Function

This API is used to update pipeline resource-level permissions status.

Calling Method

For details, see Calling APIs.

URI

PUT /v5/{project_id}/api/pipeline-permissions/{pipeline_id}/update-permission-switch

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

pipeline_id

Yes

String

Definition:

Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

flag

Yes

Boolean

Definition:

Whether to enable resource-level permissions.

Constraints:

N/A

Value range:

  • true: The resource-level permissions are enabled.

  • false: The resource-level permissions are disabled.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Value range:

N/A

Example Requests

PUT https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipeline-permissions/53acae73a3f44b2994f9b20a710721c6/update-permission-switch?flag=true

Example Responses

Status code: 200

Response body.

{
  "status" : "success"
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.