POST
/v2/apis/{apiId}/deployments
http://apigateway.{region}.amazonaws.com/v2/apis/{apiId}/deploymentsCreates a Deployment for an API.
Access Token Required: API Key
Path Parameters
apiIdstringrequired
The API identifier.
Body Params
stageNamestring
A string with a length between [1-128].
descriptionstring
A string with a length between [0-1024].
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}/deployments' \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}