Edit stage

Prev Next

Available in Classic and VPC

Change the settings of a deployment stage.

Request

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

Method URI
PATCH /api/v1/project/{projectId}/stage/{stageId}

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

Request body

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

Field Type Required Description
name String Optional Deployment stage name
  • Enter up to 100 characters by combining English letters, numbers, and special characters "-" and "_".
  • Enter when editing the name.
type String Optional Deployment target type
  • Server | AutoScalingGroup | KubernetesService | ObjectStorage
  • Enter when editing the deployment target.
config Object Optional Deployment target settings

TEnvServer

The following describes config if the deployment target is Server.

Field Type Required Description
serverNo Array Required Target server number list

TEnvAutoScalingGroup

The following describes config if the deployment target is AutoScalingGroup.

Field Type Required Description
autoScalingGroupNo Number Required Target Auto Scaling group number

TEnvKubernetesService

The following describes config if the deployment target is KubernetesService.

Field Type Required Description
clusterNo Number Required Target cluster number

TEnvObjectStorage

The following describes config if the deployment target is ObjectStorage.

Field Type Required Description
bucketName String Required Target bucket name

Request example

The request example is as follows:

curl --location --request PATCH 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "type": "ObjectStorage",
    "config": {
        "bucketName": "devtool"
    }
}'

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.id String - Deployment stage ID
result.name String - Deployment stage name

Response status codes

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

Response example

{
    "result": {
        "id": "3***",
        "name": "dev1"
    }
}