/v2/apis/{apiId}/stages

POST

Creates a Stage for an API.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v2/apis//stages' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accessLogSettings": {
        "DestinationArn": "string",
        "Format": "string"
    },
    "autoDeploy": true,
    "clientCertificateId": "string",
    "defaultRouteSettings": {
        "DataTraceEnabled": true,
        "DetailedMetricsEnabled": true,
        "LoggingLevel": "ERROR",
        "ThrottlingBurstLimit": 0,
        "ThrottlingRateLimit": 0
    },
    "deploymentId": "string",
    "description": "string",
    "routeSettings": {
        "property1": {
            "DataTraceEnabled": true,
            "DetailedMetricsEnabled": true,
            "LoggingLevel": "ERROR",
            "ThrottlingBurstLimit": 0,
            "ThrottlingRateLimit": 0
        }
    },
    "stageName": "string",
    "stageVariables": {
        "property1": "string",
        "property2": "string"
    },
    "tags": {
        "property1": "string",
        "property2": "string"
    }
}'

Response Example

201 - Example 1

{
    "AccessLogSettings": {
        "DestinationArn": "string",
        "Format": "string"
    },
    "ApiGatewayManaged": true,
    "AutoDeploy": true,
    "ClientCertificateId": "string",
    "CreatedDate": "string",
    "DefaultRouteSettings": {
        "DataTraceEnabled": true,
        "DetailedMetricsEnabled": true,
        "LoggingLevel": "ERROR",
        "ThrottlingBurstLimit": 0,
        "ThrottlingRateLimit": 0
    },
    "DeploymentId": "string",
    "Description": "string",
    "LastDeploymentStatusMessage": "string",
    "LastUpdatedDate": "string",
    "RouteSettings": {
        "property1": {},
        "property2": {}
    },
    "StageName": "string",
    "StageVariables": {
        "property1": "string",
        "property2": "string"
    },
    "Tags": {
        "property1": "string",
        "property2": "string"
    }
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Success

application/json

Body

🟠480NotFoundException

🟠481TooManyRequestsException

🟠482BadRequestException

🟠483ConflictException

Modified at 2023-08-15 05:49:07

/v2/apis/{apiId}/routes/{routeId}/routeresponses

/v2/apis/{apiId}/stages