Cancel build

Prev Next

Available in Classic and VPC

Cancel SourceBuild project build.

Request

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

Method URI
DELETE /api/v1/project/{projectId}/build

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
projectId String Required Project ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
buildId String Required Build number

Request example

The request example is as follows:

curl --location --request DELETE 'https://sourcebuild.apigw.ntruss.com/api/v1/project/20***/build' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "buildId": "9e681620-****-****-****-47858606706c"
}'

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 response status codes common to all SourceBuild APIs, see SourceBuild response status codes.

Response example

The response example is as follows:

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