Internal Endpoints

Overview of LocalStack and AWS specific internal endpoints for local development and testing

LocalStack provides several internal endpoints for various local AWS services and LocalStack-specific features. These endpoints are not part of the official AWS API and are available in the /_localstack and /_aws paths. You can use cURL or your favourite HTTP REST client to access endpoints.

LocalStack endpoints

The API path for the LocalStack internal resources is /_localstack. The following endpoints are available:

EndpointDescription
/_localstack/healthTo check the available and running AWS services in LocalStack. You can use the endpoint to restart the LocalStack services.
/_localstack/pluginsShows the Plux plugins information in LocalStack.
/_localstack/initShows the initialization status after setting up Init hooks.
/_localstack/cloudformation/deployEnables you to deploy CloudFormation templates locally through a web interface.
/_localstack/diagnoseReports extensive and sensitive data from LocalStack instance, enabled via the DEBUG=1 configuration variable.
/_localstack/configEnables dynamic configuration updates at runtime, enabled via the ENABLE_CONFIG_UPDATES configuration variable.
/_localstack/state/<service>/saveGet a snapshot of the given AWS service using the Persistence mechanism.
/_localstack/state/<service>/loadLoad the most recent snapshot of the given service using the Persistence mechanism.
/_localstack/state/resetReset the state of the services using the Persistence mechanism.
/_localstack/state/<service>/resetReset the state of the given service using the Persistence mechanism.

AWS endpoints

The API path for the AWS internal resources is /_aws. The following endpoints are available:

EndpointDescription
/_aws/lambda/runtimesList Lambda runtimes. See Lambda – Special Tools
/_aws/sqs/messagesAccess all messages within a SQS queue
/_aws/sns/platform-endpoint-messagesAccess and delete all the published SNS platform messages
/_aws/sesAccess and delete all the sent SES emails
/_aws/cloudwatch/metrics/rawAccess all the raw CloudWatch metrics
/_aws/cognito-idpAccess the local Cognito login form
/_aws/dynamodb/expiredTrigger the DynamoDB TTL worker at convenience
Last modified July 18, 2024: setup markdownlint (#1382) (f2ebb421e)