CompressionProfile

CompressionProfile
CompressionProfile
JSON Example
{
    "buf_num": 0,
    "buf_size": 0,
    "compressible_content_ref": "string",
    "compression": false,
    "filter": [
        {
            "devices_ref": "string",
            "index": 0,
            "ip_addr_prefixes": [
                {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            ],
            "ip_addr_ranges": [
                {
                    "begin": {
                        "addr": "string",
                        "type": "string"
                    },
                    "end": {
                        "addr": "string",
                        "type": "string"
                    }
                }
            ],
            "ip_addrs": [
                {
                    "addr": "string",
                    "type": "string"
                }
            ],
            "ip_addrs_ref": "string",
            "level": "string",
            "match": "string",
            "name": "string",
            "user_agent": [
                "string"
            ]
        }
    ],
    "hash_size": 0,
    "level_aggressive": 0,
    "level_normal": 0,
    "max_low_rtt": 0,
    "min_high_rtt": 0,
    "min_length": 0,
    "mobile_str_ref": "string",
    "remove_accept_encoding_header": false,
    "type": "string",
    "window_size": 0
}
integer As int32 As int32
buf_num
Optional
Constraints: default: 128

Number of buffers to use for compression output. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
buf_size
Optional
Constraints: default: 4096

Size of each buffer used for compression output, this should ideally be a multiple of pagesize. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
compressible_content_ref
Optional

Compress only content types listed in this string group. Content types not present in this list are not compressed. It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
compression
Required

Compress HTTP response content if it wasn't already compressed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

filter
Optional

Custom filters used when auto compression is not selected. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
hash_size
Optional
Constraints: default: 16384

hash size used by compression, rounded to the last power of 2. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
level_aggressive
Optional
Constraints: default: 5

Level of compression to apply on content selected for aggressive compression. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
level_normal
Optional
Constraints: default: 1

Level of compression to apply on content selected for normal compression. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
max_low_rtt
Optional
Constraints: default: 10

If client RTT is higher than this threshold, enable normal compression on the response. Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
min_high_rtt
Optional
Constraints: default: 200

If client RTT is higher than this threshold, enable aggressive compression on the response. . Field introduced in 21.1.1. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

integer As int32 As int32
min_length
Optional
Constraints: default: 128

Minimum response content length to enable compression. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
mobile_str_ref
Optional

Values that identify mobile browsers in order to enable aggressive compression. It is a reference to an object of type StringGroup. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
remove_accept_encoding_header
Required
Constraints: default: true

Offload compression from the servers to AVI. Saves compute cycles on the servers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
type
Required
Constraints: default: AUTO_COMPRESSION

Compress content automatically or add custom filters to define compressible content and compression levels. Enum options - AUTO_COMPRESSION, CUSTOM_COMPRESSION. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As int32 As int32
window_size
Optional
Constraints: default: 4096

window size used by compression, rounded to the last power of 2. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.