Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Passing the Manual Check Point
Updated on 2025-09-08 GMT+08:00

Passing the Manual Check Point

Function

This API is used to pass the manual check point.

Calling Method

For details, see Calling APIs.

URI

POST /v5/{project_id}/api/pipelines/{pipeline_id}/pipeline-runs/{pipeline_run_id}/steps/{step_run_id}/manual/pass

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

pipeline_run_id

Yes

String

Definition:

Pipeline run ID. The return value of the API for starting a pipeline is the pipeline run ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

step_run_id

Yes

String

Pipeline step ID.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

success

Boolean

Definition:

Whether the operation is successful.

Value range:

  • true: The operation is successful.

  • false: The operation fails.

Example Requests

POST https://{endpoint}/v5/e2e18230a85d4d6ab0b56cb6d2246c18/api/pipelines/dc73b5ed58a64ab7a469b9480e5f6632/pipeline-runs/49d1f149d683497799a44f966fd285b7/jobs/a4e8a0c45e744137903461dd01fdecff/steps/4330cd5b992b4a539bb8209de3db7278/pass

Example Responses

Status code: 200

Response body.

{
  "success" : true
}

Status Codes

Status Code

Description

200

Response body.

Error Codes

See Error Codes.