GetStages - Amazon API Gateway


Gets information about one or more Stage resources.

Request Syntax

GET /restapis/restapi_id/stages?deploymentId=deploymentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The stages' deployment identifiers.


The string identifier of the associated RestApi.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "item": [ { "accessLogSettings": { "destinationArn": "string", "format": "string" }, "cacheClusterEnabled": boolean, "cacheClusterSize": "string", "cacheClusterStatus": "string", "canarySettings": { "deploymentId": "string", "percentTraffic": number, "stageVariableOverrides": { "string" : "string" }, "useStageCache": boolean }, "clientCertificateId": "string", "createdDate": number, "deploymentId": "string", "description": "string", "documentationVersion": "string", "lastUpdatedDate": number, "methodSettings": { "string" : { "cacheDataEncrypted": boolean, "cacheTtlInSeconds": number, "cachingEnabled": boolean, "dataTraceEnabled": boolean, "loggingLevel": "string", "metricsEnabled": boolean, "requireAuthorizationForCacheControl": boolean, "throttlingBurstLimit": number, "throttlingRateLimit": number, "unauthorizedCacheControlHeaderStrategy": "string" } }, "stageName": "string", "tags": { "string" : "string" }, "tracingEnabled": boolean, "variables": { "string" : "string" }, "webAclArn": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The current page of elements from this collection.

Type: Array of Stage objects


For information about the errors that are common to all actions, see Common Errors.


The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400


The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409


The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429


The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404


The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429


The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401


Get Stages

This example illustrates one usage of GetStages.

Sample Request

GET /restapis/{restapi_id}/stages?deployment_id=vakw79 HTTP/1.1 Content-Type: application/json Host: X-Amz-Date: 20160524T061752Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160524/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig-hash} Cache-Control: no-cache

Sample Response

{ "_links": { "curies": { "href": "{rel}.html", "name": "stage", "templated": true }, "self": { "href": "/restapis/{restapi_id}/stages{?deployment_id}", "templated": true }, "item": [ { "href": "/restapis/{restapi_id}/stages/beta" }, { "href": "/restapis/{restapi_id}/stages/prod" } ], "stage:by-name": { "href": "/restapis/{restapi_id}/stages/{stage_name}", "templated": true }, "stage:create": { "href": "/restapis/{restapi_id}/stages" } }, "_embedded": { "item": [ { "_links": { "self": { "href": "/restapis/{restapi_id}/stages/beta" }, "stage:delete": { "href": "/restapis/{restapi_id}/stages/beta" }, "stage:flush-authorizer-cache": { "href": "/restapis/{restapi_id}/stages/beta/cache/authorizers" }, "stage:update": { "href": "/restapis/{restapi_id}/stages/beta" } }, "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "createdDate": "2016-04-15T17:38:08Z", "deploymentId": "vakw79", "lastUpdatedDate": "2016-04-15T17:45:48Z", "methodSettings": {}, "stageName": "beta", "variables": { "version": "v-beta", "url": "", "function": "HelloWorld" } }, { "_links": { "self": { "href": "/restapis/{restapi_id}/stages/prod" }, "stage:delete": { "href": "/restapis/{restapi_id}/stages/prod" }, "stage:flush-authorizer-cache": { "href": "/restapis/{restapi_id}/stages/prod/cache/authorizers" }, "stage:update": { "href": "/restapis/{restapi_id}/stages/prod" } }, "cacheClusterEnabled": false, "cacheClusterStatus": "NOT_AVAILABLE", "createdDate": "2016-04-15T17:53:35Z", "deploymentId": "vakw79", "lastUpdatedDate": "2016-04-15T18:30:10Z", "methodSettings": {}, "stageName": "prod", "variables": { "version": "v-prod", "url": "", "function": "HelloEveryone" } } ] } }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: