Updated on 2026-09-18 GMT+08:00

Disabling a Pipeline

This API is used to disable a pipeline.

For details, see Calling APIs.

PUT /v5/{project_id}/api/pipelines/{pipeline_id}/ban

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

None

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
-	Boolean	Definition: Whether the disabling is successful. Value range: true: The disabling is successful. false: The disabling fails.

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

PUT https://{endpoint}}/v5/db8d07265e24426598b3eb03a7818972/api/pipelines/a9278e7a9f394dacb07ab2529df7c201/ban

Status code: 200

true

Status Code	Description
200	Response body for disabling pipelines.
400	Bad request
401	Unauthorized
403	Forbidden
404	Not Found

Parent topic: Pipeline Management