---
name: "CURLOPT_SSH_COMPRESSION"
section: "3"
platform: "macos"
package: "curl"
version: "166.0.0.0.1"
release: "macOS 26.5"
platforms: ["linux", "macos"]
url: "https://new.carta.tech/CURLOPT_SSH_COMPRESSION"
---

# CURLOPT\_SSH\_COMPRESSION(3)

enable SSH compression

## NAME

CURLOPT\_SSH\_COMPRESSION - enable SSH compression

## SYNOPSIS

```
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSH_COMPRESSION, long enable);
```

## DESCRIPTION

Pass a long as parameter set to 1L to enable or 0L to disable.

Enables built-in SSH compression. This is a request, not an order; the server may or may not do it.

## DEFAULT

0, disabled

## PROTOCOLS

All SSH based protocols: SCP, SFTP

## EXAMPLE

```
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    curl_easy_setopt(curl, CURLOPT_URL, "sftp://example.com");
    /* enable built-in compression */
    curl_easy_setopt(curl, CURLOPT_SSH_COMPRESSION, 1L);
    /* Perform the request */
    curl_easy_perform(curl);
  }
}
```

## AVAILABILITY

Added in 7.56.0

## RETURN VALUE

Returns CURLE\_OK if the option is supported, CURLE\_UNKNOWN\_OPTION if not, or CURLE\_OUT\_OF\_MEMORY if there was insufficient heap space.

## SEE ALSO

[**CURLOPT\_ACCEPT\_ENCODING**(3)](/CURLOPT_ACCEPT_ENCODING/3.md), [**CURLOPT\_TRANSFER\_ENCODING**(3)](/CURLOPT_TRANSFER_ENCODING/3.md)