Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472221377.0 KB

Updates a Stage.

patch/v2/apis/{apiId}/stages/{stageName}

Path parameters

apiIdstring required

The API identifier.

stageNamestring required

The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.

Request body

autoDeployboolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

clientCertificateIdstring

The identifier.

deploymentIdstring

The identifier.

descriptionstring

A string with a length between [0-1024].

routeSettingsobject

The route settings map.

stageVariablesobject

The stage variable map.

Response

Success

ApiGatewayManagedboolean

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

AutoDeployboolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

ClientCertificateIdstring

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

CreatedDatestring date-time

The timestamp when the stage was created.

DeploymentIdstring

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Descriptionstring

The description of the stage.

LastDeploymentStatusMessagestring

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

LastUpdatedDatestring date-time

The timestamp when the stage was last updated.

RouteSettingsobject

Route settings for the stage, by routeKey.

StageNamestring

The name of the stage.

StageVariablesobject

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-._~:/?#&=,]+.

Tagsobject

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