Ensure that Content Encoding feature is enabled for your Amazon API Gateway APIs in order to facilitate API payload compression. Once Content Encoding is enabled, the API Gateway service allows compression of response bodies based on client's Accept-Encoding header. API payload compression is triggered when the response body size is greater than or equal to the threshold configured as the minimum compression size (in bytes). You can set this threshold to a non-negative integer between 0 and 10485760 (10M bytes). The compression types supported by Amazon API Gateway service are GZIP, DEFLATE and identity.
This rule can help you with the following compliance standards:
This rule resolution is part of the Cloud Conformity Security & Compliance tool for AWS
efficiency
Amazon API Gateway allows your client to call your API with compressed payloads using one of the supported compression types. API Gateway service supports decompression of the request payload, however, you must configure your API to enable compression of the response payload. Enabling compression for your API payload will help you improve your API performance and reduce bandwidth utilization.
Audit
To determine if your Amazon API Gateway APIs have Content Encoding feature enabled, perform the following:
Remediation / Resolution
To enable Amazon API Gateway API payload compression using Content Encoding feature, perform the following actions:
References
- AWS Documentation
- Enable Payload Compression for an API
- Enable Compression for an API
- Receive an API Response with a Compressed Payload
- AWS Command Line Interface (CLI) Documentation
- apigateway
- get-rest-apis
- get-rest-api
- update-rest-api
Unlock the Remediation Steps
Gain free unlimited access
to our full Knowledge Base
Over 750 rules & best practices
for and
Get started for FREE
You are auditing:
Content Encoding
Risk level: Medium