Updated on 2025-03-25 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

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.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

body

Yes

Object

Request body.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

-

Boolean

Whether the enabling is successful.

Example Requests

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

Example Responses

Status code: 200

Response body.

true

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.