REST API Developer Guide

Introduction to REST API
What Is REST API?
API Compatible Editions and Development Environments
REST Resources and Requests
REST API Architecture
Authorization Through Connected Apps and OAuth 2.0
Headers
Assignment Rule Header
Call Options Header
Compression Headers
Conditional Request Headers
Duplicate Rule Header
Limit Info Header
Package Version Header
Query Options Header
Warning Header
Send REST Requests with cURL
Configure Salesforce CORS Allowlist
Valid Date and DateTime Formats
Status Codes and Error Responses
API End-of-Life
Quick Start
Examples
Generating an OpenAPI 3.0 Specification for sObjects REST API (Beta)
Reference
PDF

Newer Version Available

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

Compression Headers

Use a compression header to compress a REST API request or response. Compression reduces the bandwidth required for a request, although it requires more processing power at your client. In most cases, this tradeoff benefits the overall performance of your application.

REST API supports the gzip and deflate compression algorithms, as defined by the HTTP 1.1 specification. If you’re unsure about which one to use, gzip is more common than deflate.

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

Tip

Request Compression

Include a Content-Encoding: gzip or Content-Encoding: deflate header to compress a request. REST API decompresses any requests before processing.

This example request is compressed with gzip.

1curl https://MyDomainName.my.salesforce.com/services/data/v55.0/sobjects/Account/ -H "Authorization: Bearer access-token" -H "Content-Type: application/json" -H "Content-Encoding: gzip" —data-binary @new-account.json -X POST

Response Compression

Salesforce compresses a response only if the request contains an Accept-Encoding: gzip or Accept-Encoding: deflate header. REST API isn’t required to compress the response even if you’ve specified Accept-Encoding, but it normally does. If compressed, the response contains a Content-Encoding header with the compression algorithm so that your client knows to decompress it.

This example request asks for a compressed response.

1curl https://MyDomainName.my.salesforce.com/services/data/v55.0/sobjects/Account/0015e000009sS0DAAU -H "Authorization: Bearer access-token" -H "Content-Type: application/json" -H "Accept-Encoding: gzip" -X GET