Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit 9d6ab2b

Browse files
authored
add reference to the swagger UI (#1494)
1 parent c74aa11 commit 9d6ab2b

File tree

1 file changed

+11
-28
lines changed

1 file changed

+11
-28
lines changed

content/en/references/internal-endpoints.md

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,16 @@ LocalStack provides several internal endpoints for various local AWS services an
1212
These endpoints are not part of the official AWS API and are available in the `/_localstack` and `/_aws` paths.
1313
You can use [curl](https://curl.se/) or your favourite HTTP REST client to access endpoints.
1414

15-
## LocalStack endpoints
15+
You can start your LocalStack instance and go to [http://localhost.localstack.cloud:4566/_localstack/swagger](http://localhost.localstack.cloud:4566/_localstack/swagger)
16+
to browse the Swagger UI, visualize and interact with all the API's resources implemented in LocalStack.
1617

17-
The API path for the LocalStack internal resources is `/_localstack`.
18-
The following endpoints are available:
18+
### LocalStack endpoints
1919

20-
| Endpoint | Description |
21-
| ------------------------------------ | --------------------------------------------------------------------------- |
22-
| `/_localstack/health` | To check the available and running AWS services in LocalStack. You can use the endpoint to restart the LocalStack services. |
23-
| `/_localstack/plugins` | Shows the [Plux plugins](https://github.com/localstack/localstack/blob/master/docs/localstack-concepts/README.md#plugins) information in LocalStack. |
24-
| `/_localstack/init` | Shows the initialization status after setting up [Init hooks](https://docs.localstack.cloud/references/init-hooks/). |
25-
| `/_localstack/cloudformation/deploy` | Enables you to deploy CloudFormation templates locally through a web interface. |
26-
| `/_localstack/diagnose` | Reports extensive and sensitive data from LocalStack instance, enabled via the `DEBUG=1` configuration variable. |
27-
| `/_localstack/config` | Enables dynamic configuration updates at runtime, enabled via the `ENABLE_CONFIG_UPDATES` configuration variable. |
28-
| `/_localstack/chaos` | [Chaos API]({{< ref "chaos-api" >}}) configuration endpoint |
29-
| `/_localstack/state/<service>/save` | Get a snapshot of the given AWS service using the Persistence mechanism. |
30-
| `/_localstack/state/<service>/load` | Load the most recent snapshot of the given service using the Persistence mechanism. |
31-
| `/_localstack/state/reset` | Reset the state of the services using the Persistence mechanism. |
32-
| `/_localstack/state/<service>/reset` | Reset the state of the given service using the Persistence mechanism. |
20+
The API path for the LocalStack internal resources is `/_localstack`.
21+
Several endpoints are available under this path.
22+
For instance, `/_localstack/health` checks the available and running AWS services in LocalStack while
23+
`/_localstack/diagnose` (enable with the `DEBUG=1` configuration variable), reports extensive and sensitive data from
24+
the LocalStack instance.
3325

3426
{{< callout "tip" >}}
3527
You can use the `/_localstack/health` endpoint to restart or kill the services.
@@ -40,17 +32,8 @@ $ curl -v --request POST --header "Content-Type: application/json" --data '{"ac
4032
{{< /command >}}
4133
{{< /callout >}}
4234

43-
## AWS endpoints
35+
### AWS endpoints
4436

4537
The API path for the AWS internal resources is `/_aws`.
46-
The following endpoints are available:
47-
48-
| Endpoint | Description |
49-
|----------------------------------------|-----------------------------------------------------------|
50-
| `/_aws/lambda/runtimes` | List Lambda runtimes. See [Lambda – Special Tools]({{< ref "user-guide/aws/lambda#special-tools" >}}) |
51-
| `/_aws/sqs/messages` | Access all messages within a SQS queue |
52-
| `/_aws/sns/platform-endpoint-messages` | Access and delete all the published SNS platform messages |
53-
| `/_aws/ses` | Access and delete all the sent SES emails |
54-
| `/_aws/cloudwatch/metrics/raw` | Access all the raw CloudWatch metrics |
55-
| `/_aws/cognito-idp` | Access the local Cognito login form |
56-
| `/_aws/dynamodb/expired` | Trigger the DynamoDB TTL worker at convenience |
38+
These endpoints offer LocalStack-specific features in addition to the ones offered by the AWS services.
39+
For instance, `/aws/sqs/messages` conveniently access all messages withing a SQS queue, without deleting them.

0 commit comments

Comments
 (0)