Create a compression rule via API
Use the Rulesets API to create a compression rule via API.
Basic rule settings
When creating a compression rule via API, make sure you:
- Set the rule action to
compress_response
. - Define the parameters in the
action_parameters
field according to the settings you wish to override for matching requests. - Deploy the rule to the
http_response_compression
phase at the zone level.
Procedure
Follow this workflow to create a compression rule for a given zone via API:
Use the List zone rulesets operation to check if there is already a ruleset for the
http_response_compression
phase at the zone level.If the phase ruleset does not exist, create it using the Create a zone ruleset operation. In the new ruleset properties, set the following values:
- kind:
zone
- phase:
http_response_compression
- kind:
Use the Update a zone ruleset operation to add a compression rule to the list of ruleset rules. Alternatively, include the rule in the Create a zone ruleset request mentioned in the previous step.
Example requests
Refer to the Examples page for example API requests.