You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jul 9, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: content/en/references/configuration.md
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -75,7 +75,7 @@ This section covers configuration options that are specific to certain AWS servi
75
75
76
76
| Variable | Example Values | Description |
77
77
| - | - | - |
78
-
|`PROVIDER_OVERRIDE_APIGATEWAY`|`next_gen`| Use [the new API Gateway implementation]({{< ref "user-guide/aws/apigateway#new-api-gateway-implementation" >}}) for both API Gateway v1 and v2, available since LocalStack 3.8. |
78
+
|`PROVIDER_OVERRIDE_APIGATEWAY`|`legacy`\|`next_gen`(default)| The [new API Gateway implementation]({{< ref "user-guide/aws/apigateway#new-api-gateway-implementation" >}}) is active by default since LocalStack 4.0. |
| `S3_DIR` || **Deprecated since 3.0.0** This is only supported for the `legacy_v2` provider. Configure a global parent directory that contains all buckets as sub-directories (`S3_DIR=/path/to/root`) or an individual directory that will get mounted as special bucket names (`S3_DIR=/path/to/root/bucket1:bucket1`). Only available for Localstack Pro.
300
299
|`S3_SKIP_SIGNATURE_VALIDATION`|`0`\|`1` (default) | Used to toggle validation of S3 pre-signed URL request signature. Set to `0` to validate. Note that validation can only pass if the `AWS_SECRET_ACCESS_KEY` is set to `test` or if using credentials returned from `STS.AssumeRole`|
301
300
|`S3_SKIP_KMS_KEY_VALIDATION`|`0`\|`1` (default) | Used to toggle validation of provided KMS key in S3 operations. |
302
-
|`PROVIDER_OVERRIDE_S3`|`legacy_v2`\|`v3` (default) | The new LocalStack-native S3 provider (v3) is active by default since LocalStack 3.0. |
303
301
304
302
### StepFunctions
305
303
@@ -433,6 +431,7 @@ These configurations have already been removed and **won't have any effect** on
433
431
434
432
| Variable | Removed in | Example Values | Description |
435
433
| - | - | - | - |
434
+
| `S3_DIR` | 4.0.0 | `/path/to/root` | This was only supported for the `legacy_v2` provider. Configure a global parent directory that contains all buckets as sub-directories (`S3_DIR=/path/to/root`) or an individual directory that will get mounted as special bucket names (`S3_DIR=/path/to/root/bucket1:bucket1`). Only available for Localstack Pro.
436
435
|`<SERVICE>_BACKEND`| 3.0.0 |`http://localhost:7577`| Custom endpoint URL to use for a specific service, where `<SERVICE>` is the uppercase service name. |
437
436
|`<SERVICE>_PORT_EXTERNAL`| 3.0.0 |`4567`| Port number to expose a specific service externally . `SQS_PORT_EXTERNAL`, e.g. , is used when returning queue URLs from the SQS service to the client. |
438
437
|`ACTIVATE_NEW_POD_CLIENT`| 3.0.0 |`0`\|`1` (default) | Whether to use the new Cloud Pods client leveraging LocalStack container's APIs. |
Copy file name to clipboardExpand all lines: content/en/user-guide/aws/apigateway/index.md
+23-14Lines changed: 23 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -194,14 +194,21 @@ Create a new deployment for the API using the [`CreateDeployment`](https://docs.
194
194
{{< command >}}
195
195
$ awslocal apigateway create-deployment \
196
196
--rest-api-id <REST_API_ID> \
197
-
--stage-name test
197
+
--stage-name dev
198
198
{{< /command >}}
199
199
200
200
Your API is now ready to be invoked.
201
201
You can use [curl](https://curl.se/) or any HTTP REST client to invoke the API endpoint:
202
202
203
203
{{< command >}}
204
-
$ curl -X GET http://localhost:4566/restapis/<REST_API_ID>/test/_user_request_/test
204
+
$ curl -X GET http://<REST_API_ID>.execute-api.localhost.localstack.cloud:4566/dev/test
205
+
206
+
{"message":"Hello World"}
207
+
{{< /command >}}
208
+
209
+
You can also use our [alternative URL format]({{< ref "#alternative-url-format" >}}) in case of DNS issues:
210
+
{{< command >}}
211
+
$ curl -X GET http://localhost:4566/_aws/execute-api/<REST_API_ID>/dev/test
205
212
206
213
{"message":"Hello World"}
207
214
{{< /command >}}
@@ -210,9 +217,11 @@ $ curl -X GET http://localhost:4566/restapis/<REST_API_ID>/test/_user_request_/t
210
217
211
218
{{< callout >}}
212
219
213
-
Since [3.8.0](https://blog.localstack.cloud/localstack-release-v-3-8-0/#new-api-gateway-provider), LocalStack supports a new API Gateway implementation for both API Gateway v1 (REST API) and v2 (HTTP API).
220
+
Since `4.0`, LocalStack uses a new API Gateway implementation for both API Gateway v1 (REST API) and v2 (HTTP API) by default.
221
+
222
+
It was released in [3.8.0](https://blog.localstack.cloud/localstack-release-v-3-8-0/#new-api-gateway-provider).
223
+
If you are using LocalStack 4.0 and have been using the new implementation, please remove the [following flag]({{< ref "configuration#api-gateway" >}}) `PROVIDER_OVERRIDE_APIGATEWAY=next_gen` as it is now default.
214
224
215
-
You can [set the following flag]({{< ref "configuration#api-gateway" >}}) `PROVIDER_OVERRIDE_APIGATEWAY=next_gen` to use the new implementation.
216
225
{{< /callout >}}
217
226
218
227
We're entirely reworked how REST and HTTP APIs are invoked, to closely match the behavior on AWS.
If you are using the [new API Gateway implementation]({{< ref "#new-api-gateway-implementation" >}}), the `_user_request_` format is deprecated, and you should use the following:
311
+
The alternative URL format is an endpoint with the predefined base path `/_aws/execute-api`:
0 commit comments