Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Disable the default endpoint for
WebSocket APIs
By default, clients can invoke your API by using the execute-api endpoint that API Gateway generates for
your API. To ensure that clients can access your API only by using a custom domain name, disable the default
execute-api endpoint. When you disable the default endpoint, it affects all stages of an API.
The following procedure shows how to disable the default endpoint for a WebSocket API.
- Amazon Web Services Management Console
-
Sign in to the API Gateway console at https://console.amazonaws.cn/apigateway.
Choose an WebSocket API.
Choose API settings.
On API details, choose Edit.
For Default endpoint, select Inactive.
-
Choose Save changes.
On the main navigation pane, choose Routes.
-
Choose Deploy, and then redeploy your API or create a new stage for
the change to take effect.
- Amazon CLI
-
The following update-api command disables
the default endpoint for an WebSocket API:
aws apigatewayv2 update-api \
--api-id abcdef123 \
--disable-execute-api-endpoint
After you disable the default endpoint, you must deploy your API for the change to take effect.
The following Amazon CLI command creates a deployment.
aws apigatewayv2 create-deployment \
--api-id abcdef123 \
--stage-name dev