Cancel pipeline execution

Prev Next

Available in Classic and VPC

Cancel a pipeline execution.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/project/{projectId}/history/{historyId}/cancel

Request headers

For information about the headers common to all SourcePipeline APIs, see SourcePipeline request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
projectId String Required Pipeline ID
historyId String Required Execution job result ID

Request example

The request example is as follows:

curl --location --request POST 'https://vpcsourcepipeline.apigw.ntruss.com/api/v1/project/2***/history/54***/cancel' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
result Object - Response result
result.result Boolean - API call success status
  • Upon success, display true.
  • No field is displayed upon failure.

Response status codes

For information about the HTTP status codes common to all SourcePipeline APIs, see SourcePipeline response status codes.

Response example

The response example is as follows:

{
    "result": {
        "result": true
    }
}