View stage deployment history
- Print
- PDF
View stage deployment history
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View the history of API deployments to a specified stage.Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /products/{product-id}/apis/{api-id}/stages/{stage-id}/deployments |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id | String | Required | Product ID that the stage belongs to
|
api-id | String | Required | ID of the API that the stage belongs to
|
stage-id | String | Required | ID of the stage to view deployment history for
|
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
offset | Long | Optional | Starting point of the response data
|
limit | Long | Optional | Maximum number of response data
|
Request example
The following is a sample request.
curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***5ei7***/deployments' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
The following describes the response format.
Response syntax
The response syntax is as follows.
{
"total" : 1,
"content" : [ {
"deployedTime" : "2000-01-23T04:56:07.000+00:00",
"deploymentDescription" : "deploymentDescription",
"stageDeploymentNo" : 0,
"documentJson" : "documentJson",
"stageId" : "stageId"
} ],
"defaultDeploymentNo" : 6
}
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.
Response example
The following is a sample response.
{
"content": [
{
"stageDeploymentNo": 251***,
"deploymentDescription": "",
"stageId": "***5ei7***",
"deployedTime": "2024-05-08T02:38:43Z"
},
// (Omitted)
],
"total": 9,
"defaultDeploymentNo": 251***
}
Was this article helpful?