POST
/v2/apis/{apiId}/stages
http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/stagesCreates a Stage for an API.
Access Token Required: API Key
Path Parameters
apiIdstringrequired
The API identifier.
Body Params
tagsobject
Represents a collection of tags associated with the resource.
stageNamestringrequired
A string with a length between [1-128].
autoDeployboolean
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
descriptionstring
A string with a length between [0-1024].
deploymentIdstring
The identifier.
routeSettingsobject
The route settings map.
stageVariablesobject
The stage variable map.
accessLogSettingsobject
Settings for logging access in a stage.
clientCertificateIdstring
The identifier.
defaultRouteSettingsobject
Represents a collection of route settings.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request POST \2 --url 'http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/stages' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}