REST API Developer Guide

Introducing Lightning Platform REST API
Lightning Platform REST Resources
Using Compression
Using Conditional Requests
Using cURL in the REST Examples
Authorization Through Connected Apps and OAuth 2.0
Use CORS to Access Salesforce Resources from Web Browsers
API End-of-Life
Quick Start
Examples
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Using Compression

The REST API allows the use of compression on the request and the response, using the standards defined by the HTTP 1.1 specification. Compression is automatically supported by some clients, and can be manually added to others. Visit Salesforce for more information on particular clients.

For better performance, we suggest that clients accept and support compression as defined by the HTTP 1.1 specification.

Tip

To use compression, include the HTTP header Accept-Encoding: gzip or Accept-Encoding: deflate in a request. The REST API compresses the response if the client properly specifies this header. The response includes the header Content-Encoding: gzip or Accept-Encoding: deflate. You can also compress any request by including a Content-Encoding: gzip or Content-Encoding: deflate header.

Response Compression

The REST API can optionally compress responses. Responses are compressed only if the client sends an Accept-Encoding header. The REST API is not required to compress the response even if you have specified Accept-Encoding, but it normally does. If the REST API compresses the response, it also specifies a Content-Encoding header.

Request Compression

Clients can also compress requests. The REST API decompresses any requests before processing. The client must send a Content-Encoding HTTP header in the request with the name of the appropriate compression algorithm. For more information, see: