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	Parameter description: CodeArts project ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.
pipeline_id	Yes	String	Parameter description: Pipeline ID. Constraints: N/A. Value Range: The value contains 32 characters. Default value: N/A.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
body	Yes	Object	Request body for disabling a pipeline.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
-	Boolean	Whether the disabling is successful.

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

Status code: 200

Response body for disabling a pipeline.

true

Status Code	Description
200	Response body for disabling a pipeline.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.