Updated on 2025-09-08 GMT+08:00

Enabling a Pipeline

Function

This API is used to enable a pipeline.

Calling Method

For details, see Calling APIs.

URI

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

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

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

-

Boolean

Definition:

Whether the pipeline is successfully enabled.

Constraints:

N/A

Value range:

  • true: The pipeline is enabled successfully.

  • false: The pipeline fails to be enabled.

Default value:

N/A

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

Example Requests

PUT http://{endpoint}/v5/gdbdf969b32694524a949b5ef6b3e124a/api/pipelines/recf2018de4f4f7389f5bd470c58ce31/unban

Example Responses

Status code: 200

Response body.

true

Status Codes

Status Code

Description

200

Response body.

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.