Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function configures a cPanel account's mod_deflate setting.

Warning:

cPanel API 1 is deprecated. We strongly recommend that you do not use cPanel API 1. However, no equivalent function exists in our newer APIs.

Examples


 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$configure_mod_deflate = $cpanel->api1('OptimizeWS', 'optimizews', array('all', 'text/html') ); // Call the function.

Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $configure_mod_deflate = $cpliveapi->api1(OptimizeWS, optimizews ['all', 'text/html',]); # Call the function.

Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

<cpanel Module="OptimizeWS::optimizews ( $FORM('deflate_selection', 'deflate_mime_list') )">
 Command Line
cpapi1 --user=username OptimizeWS optimizews all text/html

Notes:

  • You must URI-encode these values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (none)

This function does not return output.

Parameters

ParametersTypeDescriptionPossible valuesExample
deflate_selectionstring

Required

The types of files to compress.

  • all — Compress all file types.
  • disabled — Disable the mod_deflate module for the cPanel account.
  • list — Compress only MIME types in the deflate_mime_list parameter.
all
deflate_mime_liststring

Required

The MIME types to compress.

  • text/html
  • text/plain
  • text/xml

text/html

Returns

This function does not return output.