Available in Classic and VPC
Deploy the created API.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /api/v1/products/{product-id}/apis/{api-id}/deploy |
Request headers
For information about the headers common to all API Gateway APIs, see API Gateway request headers.
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
String | Required | Product ID associated with the API |
api-id |
String | Required | API ID created on the product |
Request syntax
The request syntax is as follows.
{
"deploymentDescription" : "deploymentDescription",
"stageId" : "stageId"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
deploymentDescription |
String | Optional | API deployment description
|
stageId |
String | Required | Stage ID created on the API to deploy
|
Request example
The following is a sample request.
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/deploy' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"deploymentDescription" : "deployment Description",
"stageId" : "*****7mhdv"
}
Response
The following describes the response format.
Response status codes
For information about the HTTP status codes common to all API Gateway APIs, see API Gateway response status codes.