Delete scenario

Prev Next

Available in Classic and VPC

Delete a deployment scenario.

Request

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

Method URI
DELETE /api/v1/project/{projectId}/stage/{stageId}/scenario/{scenarioId}

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
projectId String Required Project ID
stageId String Required Deployment stage ID
scenarioId String Required Deployment scenario ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***/scenario/2***' \
--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 SourceDeploy APIs, see SourceDeploy response status codes.

Response example

The response example is as follows:

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