Update logzio-public-api.yml with compression info

logzio · Sep 11, 2023 · 29d21ff · 29d21ff
1 parent 05d3d6d
commit 29d21ff
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/_source/api/logzio-public-api.yml b/_source/api/logzio-public-api.yml
@@ -54,6 +54,14 @@ info:
     API call and response rates are limited to 100 concurrent API requests per account.
     To verify your rate limits or request changes to your plan, please contact your account manager or the <a class="intercom-launch" href="mailto:help@logz.io">Customer Success Team</a>.
 
+    # Compression
+    Compression is supported and recommended for all API calls. To enable compression for API responses, add the following request header:
+    
+    Header Name: Accept-Encoding
+    Header Value: deflate, gzip
+    
+    Compression is STRONGLY RECOMMENDED for 'Search' and 'Scroll' APIs, due to their potentially large response sizes.
+
 
   title: Logz.io API
   termsOfService: 'https://logz.io/about-us/terms-of-use/'