Available in Classic and VPC
Request approval of a scenario deployment.
Note
It can be called from a sub account with the requestDeploy permission.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /api/v1/project/{projectId}/stage/{stageId}/scenario/{scenarioId}/deploy/request |
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 POST 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***/scenario/2***/deploy/request' \
--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 | - | Task result |
result.historyId |
Number | - | Job result ID |
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": {
"historyId": 80***
}
}