Actions reference

Actions are the operations that a rule must perform, and which can be defined in the third step of the rule edition form. This page presents the various action types supported by

Please note that one rule can perform several actions. The actions are performed sequentially - hence you can for example decide to add a custom HTTP response header, inject Structured data in the page and override the HTML "title" and "description" meta tags in one single rule.

Action types list


The Redirection action generates a HTTP redirection.

If you are unfamiliar with HTTP redirections, please read first our guide about what is a URL redirection.

You can setup two parameters:

  • the target of the redirection (ie., the URL that the user must be redirected to). This can be a relative or absolute URL (starting with http:// or https://).
  • the status code of the redirection - choose if it must be a permanent or temporary redirection;

Redirection action

When hitting the "Use variable" button, you can reuse a marker that your may have defined in the "Source URL" trigger. This is useful to create dynamic redirection rules, that will use a part of the Source URL in the target location.

"Pro" plan project members can also use any request property in the redirection target URL. It can be:

  • the value of any request header
  • the time of the request
  • the hostname
  • the path of the request
  • the HTTP method that was used
  • the scheme of the requested URL
  • the IP address of the client

This feature can be useful in many cases. For example, it can help create scenarios based on the value of a Cookie or any request header that your CDN could add, etc.

In order to add a header value in the redirection target URL field, proceed with the following steps:

  1. Button to use a request property Hit the "Use variable" button. This will list the markers used during the "Trigger" step, and it also displays the link "Use a request property" - choose this option
  2. Button to use a request property Fill the form in the lateral panel, to select the request property that you would like to inject in the redirection target URL
  3. Button to use a request property Please note that transforms can be used to modify the injected value. For example, you may want to lowercase a header's value, or to perform replacements.
  4. Button to use a request property The property appears in the "Target URL" field

Custom Status Code

The Custom Reponse Status Code action allows to force a given status code in the HTTP response.

Many possibilities are offered by this action:

  • you could want to return a 404 Not Found response, to "drop" traffic at the proxy level. If you have recently removed content from your website and want to instruct bots and visitors to stop visiting these urls, this action can be useful and help save traffic on your backend stack;
  • or you could return a 410 Gone response (a 410 status code should be prefered if the page has completely disappeared, and you want to stop search engines from loosing time and resources visiting this page again);
  • if your website or a part of it is down for maintainance, you could want to return a 503 Service Unavailable response, to indicate that your website is not ready to handle requests;
  • etc.

Of course, you have to be careful when using this action, as it could generate HTTP errors if you configure it so!

With the action Custom Status Code, can help return the response of your needs

All the standard status codes in the range 2xx - 5xx are supported.

Meta tag override

When creating a website, it is a quite common SEO mistake to forget filling all the <meta> tags. Even optimized websites tend to have duplicates in page titles or description, which is usually not considered a SEO best-practice.

In order to avoid those issues, the SEO override action allows to fine-tune the content of this HTML meta-tags in the HTTP responses sent from your platform.

Consider, for instance, the following HTML page:

<!doctype html>
<html lang=en>
    <meta charset=utf-8>
    <p>Here goes the page content.</p>

Using the SEO override action permits to "fix" the page and inject meta tags:

<!doctype html>
<html lang=en>
    <meta charset=utf-8>
    <title>Some unique title for this page</title>
    <meta name="description">Put here a unique description for this page</meta>
    <meta name="keywords">keywords, html, page, example</meta>
    <p>Here goes the page content.</p>

Meta Tag override action

We support the override of quite an extensive list of meta tags, which should cover most of the requirements.

Custom HTTP Header

Managing the HTTP response is not only a HTML or status code story; the proxy can also help you add, delete or change response HTTP headers to the responses sent by your website.

The "Custom HTTP Header" action is a very flexible way to manage the responses sent to your users. It can be used to include custom headers required by your business (X-* headers), to add security headers, fix Content Security Policy Headers for a specific URL, etc.

Custom HTTP header action

As for the URL target of the redirection action, "Pro" plan project members can reuse any request variable in response header values:

Custom HTTP header action using the value of a request property

Insert HTML Code

This action allows to embed the string of your choice at different positions in the HTML response. This can be useful to add a stylesheet, a javascript file, or some code.

Custom HTML code action

Custom response body

This action is only available in "Pro" plan projects.

This actions allows to completely define the content of the response body. This allows to return HTML content, but also CSS stylesheets, javascript, SVG images, pure text/plain content, etc.

The custom response body action

Besides defining the content of the response, the action also allows to select a value for the Content-Type response header.

Robots.txt management

This action is only available in "Pro" plan projects.

This action can only be used when the "Source URL" is the URL of a robots.txt file, and it allows to serve a custom robots.txt file.

robots.txt management action

The action proposes 3 possibilities:

  • Allow all to allow all the crawlers to access all the pages
  • Block all to prevent all crawlers and robots to explore any page. Keep in mind that in some situations, URLs of your website may still be indexed by search engines, even if they haven't been crawled
  • Custom to define yourself the content that should be served as the robots.txt file of the website.

If the "Source URL" provided in the "Trigger" step is an absolute URL, we will automatically load your pre-existing robots.txt file:

robots.txt management action with a pre-loaded robots.txt content

Sitemap management

This action is only available in "Pro" plan projects.

Use this action to serve a sitemap.xml file at the location defined in the "Source URL" trigger.

Sitemap management action

This actions allows to define up to 50,000 entries in a sitemap content, and ensures that the provided sitemap content is valid.


This action is only available in "Pro" plan projects.

The Configuration action is useful to manage the module behavior across your website. It allows to enable or disable the processing altogether, or can just disable the logging of HTTP requests, which is something you may wan to avoid logging sensitive data.

Configuration action

For example, you may want to disable the module on your payment pages. You could also want to disable the logging on your user "change password" pages, etc.

Disabling can be done using the "Reset previous rules" and the "Stop processing rules" options:

configuration "Stop processing rules" Disabled "Stop processing rules" Enabled
"Reset previous rules" Disabled The rules execute as usual Actions defined in higher priority rules are not executed. Actions defined in lower priority rules and in this rule are executed.
"Reset previous rules" Enabled Actions defined in lower priority rules are not executed. Actions defined in higher priority rules and in this rule are executed. Actions defined in lower or higher priority are not executed. Actions defined in this rule are executed. Actions defined in other rules with the same priority may be executed.

Looking for an example of this action? Have a look at the "Redirect except a path" recipe!

This page has been updated on April 14th, 2024.
Can't find your answer?