Amazon API Gateway
API Reference

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Stages

Represents the collection of stages for an API.

URI

/v2/apis/apiId/stages

HTTP Methods

GET

Operation ID: GetStages

Gets the Stages for an API.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

Query Parameters

Name Type Required Description
nextToken String False

The next page of elements from this collection. Not valid for the last element of the collection.

maxResults String False

The maximum number of elements to be returned for this resource.

Responses

Status Code Response Model Description
200 Stages

Success

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

POST

Operation ID: CreateStage

Creates a Stage for an API.

Path Parameters

Name Type Required Description
apiId String True

The API identifier.

Responses

Status Code Response Model Description
201 Stage

The request has succeeded and has resulted in the creation of a resource.

400 BadRequestException

One of the parameters in the request is invalid.

404 NotFoundException

The resource specified in the request was not found.

409 ConflictException

The resource already exists.

429 LimitExceededException

The client is sending more than the allowed number of requests per unit of time.

Schemas

Request Bodies

Example POST

{ "stageName": "string", "description": "string", "deploymentId": "string", "clientCertificateId": "string", "defaultRouteSettings": { "detailedMetricsEnabled": boolean, "loggingLevel": enum, "dataTraceEnabled": boolean, "throttlingBurstLimit": integer, "throttlingRateLimit": number }, "routeSettings": { }, "stageVariables": { }, "accessLogSettings": { "format": "string", "destinationArn": "string" }, "tags": { } }

Response Bodies

Example Stages

{ "items": [ { "stageName": "string", "description": "string", "deploymentId": "string", "clientCertificateId": "string", "defaultRouteSettings": { "detailedMetricsEnabled": boolean, "loggingLevel": enum, "dataTraceEnabled": boolean, "throttlingBurstLimit": integer, "throttlingRateLimit": number }, "routeSettings": { }, "stageVariables": { }, "accessLogSettings": { "format": "string", "destinationArn": "string" }, "createdDate": "string", "lastUpdatedDate": "string", "tags": { } } ], "nextToken": "string" }

Example Stage

{ "stageName": "string", "description": "string", "deploymentId": "string", "clientCertificateId": "string", "defaultRouteSettings": { "detailedMetricsEnabled": boolean, "loggingLevel": enum, "dataTraceEnabled": boolean, "throttlingBurstLimit": integer, "throttlingRateLimit": number }, "routeSettings": { }, "stageVariables": { }, "accessLogSettings": { "format": "string", "destinationArn": "string" }, "createdDate": "string", "lastUpdatedDate": "string", "tags": { } }

Example BadRequestException

{ "message": "string" }

Example NotFoundException

{ "message": "string", "resourceType": "string" }

Example ConflictException

{ "message": "string" }

Example LimitExceededException

{ "message": "string", "limitType": "string" }

Properties

AccessLogSettings

Settings for logging access in a stage.

Property Type Required Description
format

string

False

A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

destinationArn

string

False

The ARN of the CloudWatch Logs log group to receive access logs.

BadRequestException

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

Property Type Required Description
message

string

False

Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

CreateStageInput

Represents the input parameters for a CreateStage request.

Property Type Required Description
stageName

string

True

The name of the stage.

description

string

False

The description for the API stage.

deploymentId

string

False

The deployment identifier of the API stage.

clientCertificateId

string

False

The identifier of a client certificate for a Stage.

defaultRouteSettings

RouteSettings

False

The default route settings for the stage.

routeSettings

RouteSettingsMap

False

Route settings for the stage.

stageVariables

StageVariablesMap

False

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

accessLogSettings

AccessLogSettings

False

Settings for logging access in this stage.

tags

Tags

False

The collection of tags. Each tag element is associated with a given resource.

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property Type Required Description
message

string

False

Describes the error encountered.

limitType

string

False

The limit type.

LoggingLevel

The logging level.

  • ERROR

  • INFO

  • false

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property Type Required Description
message

string

False

Describes the error encountered.

resourceType

string

False

The resource type.

RouteSettings

Represents a collection of route settings.

Property Type Required Description
detailedMetricsEnabled

boolean

False

Specifies whether detailed metrics are enabled.

loggingLevel

LoggingLevel

False

Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs.

dataTraceEnabled

boolean

False

Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs.

throttlingBurstLimit

integer

Format: int32

False

Specifies the throttling burst limit.

throttlingRateLimit

number

Format: double

False

Specifies the throttling rate limit.

RouteSettingsMap

The route settings map.

Property Type Required Description

*

object

False

Stage

Represents an API stage.

Property Type Required Description
stageName

string

True

The name of the stage.

description

string

False

The description of the stage.

deploymentId

string

False

The identifier of the Deployment that the Stage is associated with.

clientCertificateId

string

False

The identifier of a client certificate for a Stage.

defaultRouteSettings

RouteSettings

False

Default route settings for the stage.

routeSettings

RouteSettingsMap

False

Route settings for the stage.

stageVariables

StageVariablesMap

False

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

accessLogSettings

AccessLogSettings

False

Settings for logging access in this stage.

createdDate

string

Format: date-time

False

The timestamp when the stage was created.

lastUpdatedDate

string

Format: date-time

False

The timestamp when the stage was last updated.

tags

Tags

False

The collection of tags. Each tag element is associated with a given resource.

StageVariablesMap

The stage variable map.

Property Type Required Description

*

string

False

Stages

A collection of Stage resources that are associated with the ApiKey resource.

Property Type Required Description
items

Array of type Stage

False

The elements from this collection.

nextToken

string

False

The next page of elements from this collection. Not valid for the last element of the collection.

Tags

Represents a collection of tags associated with the resource.

Property Type Required Description

*

string

False

See Also

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

GetStages

CreateStage