Search Params

Controls for the Edgemesh® Cache.

purge | revalidate

Purge

Setting this search parameter to purge will purge the cache for the current page or resource for your region.

This purge is region based. Anyone accessing the page from within the purged region will be served the new cached resources. If you need to purge globally, you will want to use the Portal or API.

Revalidate

Setting this search parameter to revalidate will fetch the asset from the origin and update the cache in the background for your region. The difference between purge and revalidate is that the request will respond with the stale cached object until the background revalidation updates the cache. This is useful when a more performant stale response is more desirable than an un-cached response from the origin.

This revalidate is region based. Anyone accessing the page from within the revalidated region will be served the new cached resources once the background revalidation is completed. Until then they will receive a stale response. Revalidation happens automatically every 15 minutes in all regions (globally).

Bypass for Edgemesh® Optimizations.

server | client | all

Server

Setting this search parameter to server will instruct Edgemesh® Server to skip all server-side optimizations for the given request. This is equivalent to navigating directly to your upstream origin.

Client

Setting this search parameter to client will instruct Edgemesh® Client to skip all client-side optimizations for the given request. This is equivalent to requesting the given resource directly from the origin. Edgemesh® Server optimizations will still be applied where applicable.

All

Setting this search parameter to all will instruct Edgemesh® Client and Server to skip all optimizations for the given request. This is equivalent to requesting the given resource directly from the origin as if there are no Edgemesh® Products installed.

This search parameter instructs Edgemesh® Server to fetch the given resource from the specified origin. It is defined as the hostname only (no protocol).

string

This search parameter is set automatically by the Edgemesh® Server optimizer and can be controlled by the unshardScripts, unshardCss, and unshardImages configuration options. You should not have to set this manually, but custom solutions can take advantage of domain un-sharding by defining this parameter.

This search parameter instructs Edgemesh® Server to set the request referer header to the specified protocol. It is defined as the protocol only (no colon or forward slashes).

http | https

This search parameter is set automatically by the Edgemesh® Server optimizer and can be controlled by the unshardScripts, unshardCss, and unshardImages configuration options. You should not have to set this manually, but custom solutions can take advantage of domain un-sharding by defining this parameter.

This search parameter instructs Edgemesh® Server to set the request referer header to the specified hostname.

string

This search parameter is set automatically by the Edgemesh® Server optimizer and can be controlled by the unshardScripts, unshardCss, and unshardImages configuration options. You should not have to set this manually, but custom solutions can take advantage of domain un-sharding by defining this parameter.

Specify the format the image should be converted to. The auto option will serve the AVIF or WebP format to browsers that support it. If not applicable or is not specified, the original format will be used. The lossless option will bypass all optimizations for the image.

auto | avif | webp | json | lossless

auto

• Select the best image format for the requesting browser. AVIF is preferred over WebP.

avif

• Generate images in AVIF format if possible (with WebP as a fallback).

webp

• Generate images in Google WebP format. Set the quality to 100 to get the WebP lossless format.

json

• Instead of generating an image, outputs information about the image in JSON format. The JSON object will contain data such as image size (before and after resizing), source image's MIME type, and file size.

lossless

• Serve the image with no modifications or optimizations. This setting will override all other settings.

Specifies quality for images in JPEG, WebP, and AVIF formats. The quality is on a 1-100 scale, but useful values are between 50 (low quality, small file size) and 90 (high quality, large file size). 85 is the default. When using the PNG format, an explicit quality setting allows the use of PNG8 (palette) variant of the format.

number {0-100}

Specifies the maximum width of the image in pixels. The exact behavior depends on the fit mode.

number

Specifies the maximum height of the image in pixels. The exact behavior depends on the fit mode.

number

Device Pixel Ratio. The default is 1. A multiplier for width/height that makes it easier to specify higher DPI sizes in <img srcset />.

number

Background color to add underneath the image. Applies only to images with transparency (for example, PNG). Accepts any CSS color, such as #RRGGBB and rgba(…).

string

Blur radius between 1 (slight blur) and 250 (maximum). Be aware that you cannot use this option to reliably obscure image content because savvy users can modify an image's URL and remove the blur option.

number {1-250}

Adds a border around the image. The border is added after resizing. Border width takes DPR into account, and can be specified either using a single width property or individually for each side (in pixels). The color can be any valid CSS value.

string

color;width

color;top;right;bottom;left

Increase the brightness by a factor. A value of 1.0 equals no change, a value of 0.5 equals half brightness, and a value of 2.0 equals twice as bright. 0 is ignored.

number

Increase the contrast by a factor. A value of 1.0 equals no change, a value of 0.5 equals low contrast, and a value of 2.0 equals high contrast. 0 is ignored.

number

Increase the exposure by a factor. A value of 1.0 equals no change, a value of 0.5 darkens the image, and a value of 2.0 lightens the image. 0 is ignored.

number

Specifies the strength of the sharpening filter to apply to the image. The value is a floating-point number between 0 (no sharpening, default) and 10 (maximum). 1 is a recommended value for downscaled images.

number {0-10}

Affects the interpretation of width and height. All resizing modes preserve the aspect ratio. Used as a string in Workers integration. Available modes are:

contain | scale-down | cover | crop | pad

contain

• The image will be resized (shrunk or enlarged) to be as large as possible within the given width or height while preserving the aspect ratio. If you only provide a single dimension (for example, only width), the image will be shrunk or enlarged to exactly match that dimension.

scale-down

• Similar to contain, but the image is never enlarged. If the image is larger than the given width or height, it will be resized. Otherwise, its original size will be kept.

cover

• Resizes (shrinks or enlarges) to fill the entire area of width and height. If the image has an aspect ratio different from the ratio of width and height, it will be cropped to fit.

crop

• Image will be shrunk and cropped to fit within the area specified by width and height. The image will not be enlarged. For images smaller than the given dimensions, it is the same as scale-down. For images larger than the given dimensions, it is the same as cover. See also trim.

pad

• Resizes to the maximum size that fits within the given width and height, and then fills the remaining area with a background color (white by default). This mode is not recommended, since you can achieve the same effect more efficiently with the contain mode and the CSS object-fit: contain property.

Specifies the number of pixels to cut off on each side. Allows removal of borders or cutting out a specific fragment of an image. Trimming is performed before resizing or rotation and takes DPR into account. Trim is defined as four numbers in pixels separated by a semicolon, in the form of top;right;bottom;left.

string

The number of degrees (90, 180, or 270) to rotate the image. The width and height options refer to axes after rotation.

90 | 180 | 270

When cropping with em-fit=cover or em-fit=crop, this parameter defines the side or point that should not be cropped.

auto | left | right | top | bottom | string

auto

• Selects focal point based on saliency detection (using maximum symmetric surround algorithm).

side

• A side (left, right, top, bottom) or coordinates specified on a scale from 0.0 (top or left) to 1.0 (bottom or right), 0.5 being the center. The X and Y coordinates are separated by a semicolon. For example, 0;1 means left and bottom, 0.5;0.5 is center, and 0.5;0.33 is a point in the top third of the image.

Controls the amount of invisible metadata (EXIF data) that should be preserved. Color profiles and EXIF rotation are applied to the image even if the metadata is discarded. Note that if the Polish feature is enabled, all metadata may have been removed already and this option will have no effect.

keep | copyright | none

keep

• Preserves most of EXIF metadata, including GPS location if present.

copyright

• Discard all metadata except EXIF copyright tag. This is the default behavior for JPEG images.

none

• Discard all invisible EXIF metadata. Currently, WebP and PNG output formats always discard metadata.

Setting this parameter instructs Edgemesh® Server to respond with the pre-rendered version of the website. This is the version that is served to bots and search engines. This parameter is provided to test and optimize pages for SEO.

true | false

Setting this parameter instructs Edgemesh® Server to treat the requesting browser as a bot. This is used to test routing for unverified and malicious bots.

This parameter is a boolean and no value is required.

Setting this parameter instructs Edgemesh® Server to add Server-Timing headers that will display server-side performance timings in supporting developer tools.

This parameter is a boolean and no value is required.

Enabling this parameter on Edgemesh® Server provides additional debugging details. Currently, it stops dynamic fragments from removing configuration parameters in server responses, allowing you to view their setup directly in the developer tools inspector instead of referring back to the source code. Future updates will expand this parameter's functionality to include more debugging information as new use cases are identified.

This parameter is a boolean and no value is required.

This parameter sets the deployment track for all static assets, namely the Edgemesh® Client script.

stable | canary | nightly

stable

• Production track. All customers run on this track unless a new feature is being tested on a customer's behalf.

canary

• This track is for testing features that are stable and ready to be promoted to production. Customers can set their staging sites to this track to run integration tests with new features.

nightly

• This track is used to test potentially unstable new features. Customer production sites are never set to this track. Only staging sites are eligible for this track.

This parameter sets the deployment track for the Edgemesh API used to collect performance metrics and analytic data. You should not change this unless instructed to by an Edgemesh® Engineer.

stable | canary | nightly

stable

• Production track. All customers run on this track unless a new feature is being tested on a customer's behalf.

canary

• This track is for testing features that are stable and ready to be promoted to production. Customers can set their staging sites to this track to run integration tests with new features.

nightly

• This track is used to test potentially unstable new features. Customer production sites are never set to this track. Only staging sites are eligible for this track.

This parameter can be used to enable or disable the static prerender feature.

true | false

This parameter can be used to enable or disable the edge caching feature.

true | false

This parameter can be used to set the revalidation time for site resources. Pages are continuously revalidated. The value is the number of seconds before the cached responses are revalidated.

number

This parameter can be used to set the default max-age a resource will exist in the edge cache. This value is only used if the upstream origin does not provide a cache-control header.

number

This parameter can be used to enable or disable the tag-less tracking and edge analytics feature.

true | false

This parameter can be used to enable or disable the image optimization feature.

true | false

This parameter can be used to set the default image quality used by the image optimization feature. This can be overridden by specific assets using the em-quality attribute.

number {0-100}

This parameter can be used to enable or disable the bot and ad fraud protection feature.

true | false

This parameter can be used to enable or disable domain unsharding for images.

true | false

This parameter can be used to enable or disable domain unsharding for CSS.

true | false

This parameter can be used to enable or disable domain unsharding for scripts.

true | false

This parameter can be used to enable or disable minification for HTML.

true | false

This parameter can be used to enable or disable minification for CSS.

true | false

This parameter can be used to enable or disable minification for scripts.

true | false

This parameter can be used to enable or disable injection of the Edgemesh® Client.

true | false

This parameter can be used to enable or disable the Shopify platform plugin.

true | false