Available in Classic and VPC
Create a deployment stage.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/project/{projectId}/stage |
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
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
name |
String | Required | Deployment stage name
|
type |
String | Required | Deployment target type
|
config |
Object | Required | Deployment target settings
|
TEnvServer
The following describes TEnvServer
.
Field | Type | Required | Description |
---|---|---|---|
serverNo |
Array | Required | Target server number list
|
TEnvAutoScalingGroup
The following describes TEnvAutoScalingGroup
.
Field | Type | Required | Description |
---|---|---|---|
autoScalingGroupNo |
Number | Required | Target Auto Scaling group number |
TEnvKubernetesService
The following describes TEnvKubernetesService
.
Field | Type | Required | Description |
---|---|---|---|
clusterNo |
Number | Required | Target cluster number |
TEnvObjectStorage
The following describes TEnvObjectStorage
.
Field | Type | Required | Description |
---|---|---|---|
bucketName |
String | Required | Target bucket name |
Request example
The request example is as follows:
curl --location --request POST 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage' \
--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 '{
"name": "dev1",
"type": "Server",
"config": {
"serverNo": [1011*****, 1011*****]
}
}'
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 |
Number | - | 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
The response example is as follows:
{
"result": {
"id": 3***,
"name": "dev1"
}
}