1. Packages
  2. Gcore Provider
  3. API Docs
  4. getCdnRuleTemplate
Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

gcore.getCdnRuleTemplate

Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core
Schema (JSON)
g-core/terraform-provider-gcore

    CDN rule templates define reusable rule configurations that can be applied across multiple CDN resources for consistent caching, delivery, and security policies.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as gcore from "@pulumi/gcore";

const exampleCdnRuleTemplate = gcore.getCdnRuleTemplate({
    ruleTemplateId: 0,
});

    import pulumi
import pulumi_gcore as gcore

example_cdn_rule_template = gcore.get_cdn_rule_template(rule_template_id=0)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.LookupCdnRuleTemplate(ctx, &gcore.LookupCdnRuleTemplateArgs{
			RuleTemplateId: 0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    var exampleCdnRuleTemplate = Gcore.GetCdnRuleTemplate.Invoke(new()
    {
        RuleTemplateId = 0,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcore.GcoreFunctions;
import com.pulumi.gcore.inputs.GetCdnRuleTemplateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleCdnRuleTemplate = GcoreFunctions.getCdnRuleTemplate(GetCdnRuleTemplateArgs.builder()
            .ruleTemplateId(0)
            .build());

    }
}

    variables:
  exampleCdnRuleTemplate:
    fn::invoke:
      function: gcore:getCdnRuleTemplate
      arguments:
        ruleTemplateId: 0

    Using getCdnRuleTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCdnRuleTemplate(args: GetCdnRuleTemplateArgs, opts?: InvokeOptions): Promise<GetCdnRuleTemplateResult>
function getCdnRuleTemplateOutput(args: GetCdnRuleTemplateOutputArgs, opts?: InvokeOptions): Output<GetCdnRuleTemplateResult>
    def get_cdn_rule_template(rule_template_id: Optional[float] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCdnRuleTemplateResult
def get_cdn_rule_template_output(rule_template_id: Optional[pulumi.Input[float]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCdnRuleTemplateResult]
    func LookupCdnRuleTemplate(ctx *Context, args *LookupCdnRuleTemplateArgs, opts ...InvokeOption) (*LookupCdnRuleTemplateResult, error)
func LookupCdnRuleTemplateOutput(ctx *Context, args *LookupCdnRuleTemplateOutputArgs, opts ...InvokeOption) LookupCdnRuleTemplateResultOutput

    > Note: This function is named LookupCdnRuleTemplate in the Go SDK.

    public static class GetCdnRuleTemplate 
{
    public static Task<GetCdnRuleTemplateResult> InvokeAsync(GetCdnRuleTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetCdnRuleTemplateResult> Invoke(GetCdnRuleTemplateInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCdnRuleTemplateResult> getCdnRuleTemplate(GetCdnRuleTemplateArgs args, InvokeOptions options)
public static Output<GetCdnRuleTemplateResult> getCdnRuleTemplate(GetCdnRuleTemplateArgs args, InvokeOptions options)

    fn::invoke:
  function: gcore:index/getCdnRuleTemplate:getCdnRuleTemplate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getCdnRuleTemplate Result

    The following output properties are available:

    Client double
    Client ID
    Default bool
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    Deleted bool
    Id double
    Name string
    Options GetCdnRuleTemplateOptions
    OverrideOriginProtocol string
    Rule string
    RuleTemplateId double
    RuleType double
    Template bool
    Weight double
    Client float64
    Client ID
    Default bool
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    Deleted bool
    Id float64
    Name string
    Options GetCdnRuleTemplateOptions
    OverrideOriginProtocol string
    Rule string
    RuleTemplateId float64
    RuleType float64
    Template bool
    Weight float64
    client Double
    Client ID
    default_ Boolean
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    deleted Boolean
    id Double
    name String
    options GetCdnRuleTemplateOptions
    overrideOriginProtocol String
    rule String
    ruleTemplateId Double
    ruleType Double
    template Boolean
    weight Double
    client number
    Client ID
    default boolean
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    deleted boolean
    id number
    name string
    options GetCdnRuleTemplateOptions
    overrideOriginProtocol string
    rule string
    ruleTemplateId number
    ruleType number
    template boolean
    weight number
    client float
    Client ID
    default bool
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    deleted bool
    id float
    name str
    options GetCdnRuleTemplateOptions
    override_origin_protocol str
    rule str
    rule_template_id float
    rule_type float
    template bool
    weight float
    client Number
    Client ID
    default Boolean
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    deleted Boolean
    id Number
    name String
    options Property Map
    overrideOriginProtocol String
    rule String
    ruleTemplateId Number
    ruleType Number
    template Boolean
    weight Number

    Supporting Types

    GetCdnRuleTemplateOptions

    AllowedHttpMethods GetCdnRuleTemplateOptionsAllowedHttpMethods
    HTTP methods allowed for content requests from the CDN.
    BotProtection GetCdnRuleTemplateOptionsBotProtection
    Allows to prevent online services from overloading and ensure your business workflow running smoothly.
    BrotliCompression GetCdnRuleTemplateOptionsBrotliCompression
    Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
    BrowserCacheSettings GetCdnRuleTemplateOptionsBrowserCacheSettings

    Cache expiration time for users browsers in seconds.

    Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.

    Responses with other codes will not be cached.

    CacheHttpHeaders GetCdnRuleTemplateOptionsCacheHttpHeaders

    Legacy option. Use the response_headers_hiding_policy option instead.

    HTTP Headers that must be included in the response.

    Deprecated: Deprecated

    Cors GetCdnRuleTemplateOptionsCors

    Enables or disables CORS (Cross-Origin Resource Sharing) header support.

    CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.

    CountryAcl GetCdnRuleTemplateOptionsCountryAcl
    Enables control access to content for specified countries.
    DisableCache GetCdnRuleTemplateOptionsDisableCache

    Legacy option. Use the edge_cache_settings option instead.

    Allows the complete disabling of content caching.

    Deprecated: Deprecated

    DisableProxyForceRanges GetCdnRuleTemplateOptionsDisableProxyForceRanges
    Allows 206 responses regardless of the settings of an origin source.
    EdgeCacheSettings GetCdnRuleTemplateOptionsEdgeCacheSettings

    Cache expiration time for CDN servers.

    value and default fields cannot be used simultaneously.

    Fastedge GetCdnRuleTemplateOptionsFastedge

    Allows to configure FastEdge app to be called on different request/response phases.

    Note: At least one of on_request_headers, on_request_body, on_response_headers, or on_response_body must be specified.

    FetchCompressed GetCdnRuleTemplateOptionsFetchCompressed

    Makes the CDN request compressed content from the origin.

    The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.

    Notes:

    1. fetch_compressed is not supported with gzipON or brotli_compression or slice options enabled.
    2. fetch_compressed overrides gzipON and brotli_compression in rule. If you enable it in CDN resource and want to use gzipON and brotli_compression in a rule, you have to specify "fetch_compressed": false in the rule.
    FollowOriginRedirect GetCdnRuleTemplateOptionsFollowOriginRedirect
    Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
    ForceReturn GetCdnRuleTemplateOptionsForceReturn

    Applies custom HTTP response codes for CDN content.

    The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.

    ForwardHostHeader GetCdnRuleTemplateOptionsForwardHostHeader

    Forwards the Host header from a end-user request to an origin server.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    GzipOn GetCdnRuleTemplateOptionsGzipOn

    Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.

    Notes:

    1. Compression with gzip is not supported with fetch_compressed or slice options enabled.
    2. fetch_compressed option in CDN resource settings overrides gzipON in rules. If you enable fetch_compressed in CDN resource and want to enable gzipON in rules, you need to specify "fetch_compressed":false for rules.
    HostHeader GetCdnRuleTemplateOptionsHostHeader

    Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.

    If the option is null, the Host Header value is equal to first CNAME.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    IgnoreCookie GetCdnRuleTemplateOptionsIgnoreCookie
    Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
    IgnoreQueryString GetCdnRuleTemplateOptionsIgnoreQueryString

    How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    ImageStack GetCdnRuleTemplateOptionsImageStack
    Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
    IpAddressAcl GetCdnRuleTemplateOptionsIpAddressAcl

    Controls access to the CDN resource content for specific IP addresses.

    If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.

    We recommend you use a script for automatically update IP ACL. Read more.

    LimitBandwidth GetCdnRuleTemplateOptionsLimitBandwidth
    Allows to control the download speed per connection.
    ProxyCacheKey GetCdnRuleTemplateOptionsProxyCacheKey

    Allows you to modify your cache key. If omitted, the default value is $request_uri.

    Combine the specified variables to create a key for caching.

    • $request_uri
    • $scheme
    • $uri

    Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.

    ProxyCacheMethodsSet GetCdnRuleTemplateOptionsProxyCacheMethodsSet
    Caching for POST requests along with default GET and HEAD.
    ProxyConnectTimeout GetCdnRuleTemplateOptionsProxyConnectTimeout
    The time limit for establishing a connection with the origin.
    ProxyReadTimeout GetCdnRuleTemplateOptionsProxyReadTimeout

    The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.

    Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).

    QueryParamsBlacklist GetCdnRuleTemplateOptionsQueryParamsBlacklist

    Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    QueryParamsWhitelist GetCdnRuleTemplateOptionsQueryParamsWhitelist

    Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    QueryStringForwarding GetCdnRuleTemplateOptionsQueryStringForwarding
    The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
    RedirectHttpToHttps GetCdnRuleTemplateOptionsRedirectHttpToHttps

    Enables redirect from HTTP to HTTPS.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    RedirectHttpsToHttp GetCdnRuleTemplateOptionsRedirectHttpsToHttp

    Enables redirect from HTTPS to HTTP.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    ReferrerAcl GetCdnRuleTemplateOptionsReferrerAcl
    Controls access to the CDN resource content for specified domain names.
    RequestLimiter GetCdnRuleTemplateOptionsRequestLimiter
    Option allows to limit the amount of HTTP requests.
    ResponseHeadersHidingPolicy GetCdnRuleTemplateOptionsResponseHeadersHidingPolicy
    Hides HTTP headers from an origin server in the CDN response.
    Rewrite GetCdnRuleTemplateOptionsRewrite
    Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
    SecureKey GetCdnRuleTemplateOptionsSecureKey
    Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
    Slice GetCdnRuleTemplateOptionsSlice

    Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.

    The option is based on the Slice module.

    Notes:

    1. Origin must support HTTP Range requests.
    2. Not supported with gzipON, brotli_compression or fetch_compressed options enabled.
    Sni GetCdnRuleTemplateOptionsSni

    The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.

    SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.

    The option works only if originProtocol parameter is HTTPS or MATCH.

    Stale GetCdnRuleTemplateOptionsStale
    Serves stale cached content in case of origin unavailability.
    StaticHeaders GetCdnRuleTemplateOptionsStaticHeaders

    Legacy option. Use the static_response_headers option instead.

    Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.

    Deprecated: Deprecated

    StaticRequestHeaders GetCdnRuleTemplateOptionsStaticRequestHeaders
    Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
    StaticResponseHeaders GetCdnRuleTemplateOptionsStaticResponseHeaders
    Custom HTTP Headers that a CDN server adds to a response.
    UserAgentAcl GetCdnRuleTemplateOptionsUserAgentAcl
    Controls access to the content for specified User-Agents.
    Waap GetCdnRuleTemplateOptionsWaap
    Allows to enable WAAP (Web Application and API Protection).
    Websockets GetCdnRuleTemplateOptionsWebsockets
    Enables or disables WebSockets connections to an origin server.
    AllowedHttpMethods GetCdnRuleTemplateOptionsAllowedHttpMethods
    HTTP methods allowed for content requests from the CDN.
    BotProtection GetCdnRuleTemplateOptionsBotProtection
    Allows to prevent online services from overloading and ensure your business workflow running smoothly.
    BrotliCompression GetCdnRuleTemplateOptionsBrotliCompression
    Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
    BrowserCacheSettings GetCdnRuleTemplateOptionsBrowserCacheSettings

    Cache expiration time for users browsers in seconds.

    Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.

    Responses with other codes will not be cached.

    CacheHttpHeaders GetCdnRuleTemplateOptionsCacheHttpHeaders

    Legacy option. Use the response_headers_hiding_policy option instead.

    HTTP Headers that must be included in the response.

    Deprecated: Deprecated

    Cors GetCdnRuleTemplateOptionsCors

    Enables or disables CORS (Cross-Origin Resource Sharing) header support.

    CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.

    CountryAcl GetCdnRuleTemplateOptionsCountryAcl
    Enables control access to content for specified countries.
    DisableCache GetCdnRuleTemplateOptionsDisableCache

    Legacy option. Use the edge_cache_settings option instead.

    Allows the complete disabling of content caching.

    Deprecated: Deprecated

    DisableProxyForceRanges GetCdnRuleTemplateOptionsDisableProxyForceRanges
    Allows 206 responses regardless of the settings of an origin source.
    EdgeCacheSettings GetCdnRuleTemplateOptionsEdgeCacheSettings

    Cache expiration time for CDN servers.

    value and default fields cannot be used simultaneously.

    Fastedge GetCdnRuleTemplateOptionsFastedge

    Allows to configure FastEdge app to be called on different request/response phases.

    Note: At least one of on_request_headers, on_request_body, on_response_headers, or on_response_body must be specified.

    FetchCompressed GetCdnRuleTemplateOptionsFetchCompressed

    Makes the CDN request compressed content from the origin.

    The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.

    Notes:

    1. fetch_compressed is not supported with gzipON or brotli_compression or slice options enabled.
    2. fetch_compressed overrides gzipON and brotli_compression in rule. If you enable it in CDN resource and want to use gzipON and brotli_compression in a rule, you have to specify "fetch_compressed": false in the rule.
    FollowOriginRedirect GetCdnRuleTemplateOptionsFollowOriginRedirect
    Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
    ForceReturn GetCdnRuleTemplateOptionsForceReturn

    Applies custom HTTP response codes for CDN content.

    The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.

    ForwardHostHeader GetCdnRuleTemplateOptionsForwardHostHeader

    Forwards the Host header from a end-user request to an origin server.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    GzipOn GetCdnRuleTemplateOptionsGzipOn

    Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.

    Notes:

    1. Compression with gzip is not supported with fetch_compressed or slice options enabled.
    2. fetch_compressed option in CDN resource settings overrides gzipON in rules. If you enable fetch_compressed in CDN resource and want to enable gzipON in rules, you need to specify "fetch_compressed":false for rules.
    HostHeader GetCdnRuleTemplateOptionsHostHeader

    Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.

    If the option is null, the Host Header value is equal to first CNAME.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    IgnoreCookie GetCdnRuleTemplateOptionsIgnoreCookie
    Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
    IgnoreQueryString GetCdnRuleTemplateOptionsIgnoreQueryString

    How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    ImageStack GetCdnRuleTemplateOptionsImageStack
    Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
    IpAddressAcl GetCdnRuleTemplateOptionsIpAddressAcl

    Controls access to the CDN resource content for specific IP addresses.

    If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.

    We recommend you use a script for automatically update IP ACL. Read more.

    LimitBandwidth GetCdnRuleTemplateOptionsLimitBandwidth
    Allows to control the download speed per connection.
    ProxyCacheKey GetCdnRuleTemplateOptionsProxyCacheKey

    Allows you to modify your cache key. If omitted, the default value is $request_uri.

    Combine the specified variables to create a key for caching.

    • $request_uri
    • $scheme
    • $uri

    Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.

    ProxyCacheMethodsSet GetCdnRuleTemplateOptionsProxyCacheMethodsSet
    Caching for POST requests along with default GET and HEAD.
    ProxyConnectTimeout GetCdnRuleTemplateOptionsProxyConnectTimeout
    The time limit for establishing a connection with the origin.
    ProxyReadTimeout GetCdnRuleTemplateOptionsProxyReadTimeout

    The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.

    Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).

    QueryParamsBlacklist GetCdnRuleTemplateOptionsQueryParamsBlacklist

    Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    QueryParamsWhitelist GetCdnRuleTemplateOptionsQueryParamsWhitelist

    Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    QueryStringForwarding GetCdnRuleTemplateOptionsQueryStringForwarding
    The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
    RedirectHttpToHttps GetCdnRuleTemplateOptionsRedirectHttpToHttps

    Enables redirect from HTTP to HTTPS.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    RedirectHttpsToHttp GetCdnRuleTemplateOptionsRedirectHttpsToHttp

    Enables redirect from HTTPS to HTTP.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    ReferrerAcl GetCdnRuleTemplateOptionsReferrerAcl
    Controls access to the CDN resource content for specified domain names.
    RequestLimiter GetCdnRuleTemplateOptionsRequestLimiter
    Option allows to limit the amount of HTTP requests.
    ResponseHeadersHidingPolicy GetCdnRuleTemplateOptionsResponseHeadersHidingPolicy
    Hides HTTP headers from an origin server in the CDN response.
    Rewrite GetCdnRuleTemplateOptionsRewrite
    Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
    SecureKey GetCdnRuleTemplateOptionsSecureKey
    Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
    Slice GetCdnRuleTemplateOptionsSlice

    Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.

    The option is based on the Slice module.

    Notes:

    1. Origin must support HTTP Range requests.
    2. Not supported with gzipON, brotli_compression or fetch_compressed options enabled.
    Sni GetCdnRuleTemplateOptionsSni

    The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.

    SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.

    The option works only if originProtocol parameter is HTTPS or MATCH.

    Stale GetCdnRuleTemplateOptionsStale
    Serves stale cached content in case of origin unavailability.
    StaticHeaders GetCdnRuleTemplateOptionsStaticHeaders

    Legacy option. Use the static_response_headers option instead.

    Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.

    Deprecated: Deprecated

    StaticRequestHeaders GetCdnRuleTemplateOptionsStaticRequestHeaders
    Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
    StaticResponseHeaders GetCdnRuleTemplateOptionsStaticResponseHeaders
    Custom HTTP Headers that a CDN server adds to a response.
    UserAgentAcl GetCdnRuleTemplateOptionsUserAgentAcl
    Controls access to the content for specified User-Agents.
    Waap GetCdnRuleTemplateOptionsWaap
    Allows to enable WAAP (Web Application and API Protection).
    Websockets GetCdnRuleTemplateOptionsWebsockets
    Enables or disables WebSockets connections to an origin server.
    allowedHttpMethods GetCdnRuleTemplateOptionsAllowedHttpMethods
    HTTP methods allowed for content requests from the CDN.
    botProtection GetCdnRuleTemplateOptionsBotProtection
    Allows to prevent online services from overloading and ensure your business workflow running smoothly.
    brotliCompression GetCdnRuleTemplateOptionsBrotliCompression
    Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
    browserCacheSettings GetCdnRuleTemplateOptionsBrowserCacheSettings

    Cache expiration time for users browsers in seconds.

    Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.

    Responses with other codes will not be cached.

    cacheHttpHeaders GetCdnRuleTemplateOptionsCacheHttpHeaders

    Legacy option. Use the response_headers_hiding_policy option instead.

    HTTP Headers that must be included in the response.

    Deprecated: Deprecated

    cors GetCdnRuleTemplateOptionsCors

    Enables or disables CORS (Cross-Origin Resource Sharing) header support.

    CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.

    countryAcl GetCdnRuleTemplateOptionsCountryAcl
    Enables control access to content for specified countries.
    disableCache GetCdnRuleTemplateOptionsDisableCache

    Legacy option. Use the edge_cache_settings option instead.

    Allows the complete disabling of content caching.

    Deprecated: Deprecated

    disableProxyForceRanges GetCdnRuleTemplateOptionsDisableProxyForceRanges
    Allows 206 responses regardless of the settings of an origin source.
    edgeCacheSettings GetCdnRuleTemplateOptionsEdgeCacheSettings

    Cache expiration time for CDN servers.

    value and default fields cannot be used simultaneously.

    fastedge GetCdnRuleTemplateOptionsFastedge

    Allows to configure FastEdge app to be called on different request/response phases.

    Note: At least one of on_request_headers, on_request_body, on_response_headers, or on_response_body must be specified.

    fetchCompressed GetCdnRuleTemplateOptionsFetchCompressed

    Makes the CDN request compressed content from the origin.

    The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.

    Notes:

    1. fetch_compressed is not supported with gzipON or brotli_compression or slice options enabled.
    2. fetch_compressed overrides gzipON and brotli_compression in rule. If you enable it in CDN resource and want to use gzipON and brotli_compression in a rule, you have to specify "fetch_compressed": false in the rule.
    followOriginRedirect GetCdnRuleTemplateOptionsFollowOriginRedirect
    Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
    forceReturn GetCdnRuleTemplateOptionsForceReturn

    Applies custom HTTP response codes for CDN content.

    The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.

    forwardHostHeader GetCdnRuleTemplateOptionsForwardHostHeader

    Forwards the Host header from a end-user request to an origin server.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    gzipOn GetCdnRuleTemplateOptionsGzipOn

    Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.

    Notes:

    1. Compression with gzip is not supported with fetch_compressed or slice options enabled.
    2. fetch_compressed option in CDN resource settings overrides gzipON in rules. If you enable fetch_compressed in CDN resource and want to enable gzipON in rules, you need to specify "fetch_compressed":false for rules.
    hostHeader GetCdnRuleTemplateOptionsHostHeader

    Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.

    If the option is null, the Host Header value is equal to first CNAME.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    ignoreCookie GetCdnRuleTemplateOptionsIgnoreCookie
    Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
    ignoreQueryString GetCdnRuleTemplateOptionsIgnoreQueryString

    How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    imageStack GetCdnRuleTemplateOptionsImageStack
    Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
    ipAddressAcl GetCdnRuleTemplateOptionsIpAddressAcl

    Controls access to the CDN resource content for specific IP addresses.

    If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.

    We recommend you use a script for automatically update IP ACL. Read more.

    limitBandwidth GetCdnRuleTemplateOptionsLimitBandwidth
    Allows to control the download speed per connection.
    proxyCacheKey GetCdnRuleTemplateOptionsProxyCacheKey

    Allows you to modify your cache key. If omitted, the default value is $request_uri.

    Combine the specified variables to create a key for caching.

    • $request_uri
    • $scheme
    • $uri

    Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.

    proxyCacheMethodsSet GetCdnRuleTemplateOptionsProxyCacheMethodsSet
    Caching for POST requests along with default GET and HEAD.
    proxyConnectTimeout GetCdnRuleTemplateOptionsProxyConnectTimeout
    The time limit for establishing a connection with the origin.
    proxyReadTimeout GetCdnRuleTemplateOptionsProxyReadTimeout

    The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.

    Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).

    queryParamsBlacklist GetCdnRuleTemplateOptionsQueryParamsBlacklist

    Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    queryParamsWhitelist GetCdnRuleTemplateOptionsQueryParamsWhitelist

    Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    queryStringForwarding GetCdnRuleTemplateOptionsQueryStringForwarding
    The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
    redirectHttpToHttps GetCdnRuleTemplateOptionsRedirectHttpToHttps

    Enables redirect from HTTP to HTTPS.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    redirectHttpsToHttp GetCdnRuleTemplateOptionsRedirectHttpsToHttp

    Enables redirect from HTTPS to HTTP.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    referrerAcl GetCdnRuleTemplateOptionsReferrerAcl
    Controls access to the CDN resource content for specified domain names.
    requestLimiter GetCdnRuleTemplateOptionsRequestLimiter
    Option allows to limit the amount of HTTP requests.
    responseHeadersHidingPolicy GetCdnRuleTemplateOptionsResponseHeadersHidingPolicy
    Hides HTTP headers from an origin server in the CDN response.
    rewrite GetCdnRuleTemplateOptionsRewrite
    Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
    secureKey GetCdnRuleTemplateOptionsSecureKey
    Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
    slice GetCdnRuleTemplateOptionsSlice

    Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.

    The option is based on the Slice module.

    Notes:

    1. Origin must support HTTP Range requests.
    2. Not supported with gzipON, brotli_compression or fetch_compressed options enabled.
    sni GetCdnRuleTemplateOptionsSni

    The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.

    SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.

    The option works only if originProtocol parameter is HTTPS or MATCH.

    stale GetCdnRuleTemplateOptionsStale
    Serves stale cached content in case of origin unavailability.
    staticHeaders GetCdnRuleTemplateOptionsStaticHeaders

    Legacy option. Use the static_response_headers option instead.

    Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.

    Deprecated: Deprecated

    staticRequestHeaders GetCdnRuleTemplateOptionsStaticRequestHeaders
    Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
    staticResponseHeaders GetCdnRuleTemplateOptionsStaticResponseHeaders
    Custom HTTP Headers that a CDN server adds to a response.
    userAgentAcl GetCdnRuleTemplateOptionsUserAgentAcl
    Controls access to the content for specified User-Agents.
    waap GetCdnRuleTemplateOptionsWaap
    Allows to enable WAAP (Web Application and API Protection).
    websockets GetCdnRuleTemplateOptionsWebsockets
    Enables or disables WebSockets connections to an origin server.
    allowedHttpMethods GetCdnRuleTemplateOptionsAllowedHttpMethods
    HTTP methods allowed for content requests from the CDN.
    botProtection GetCdnRuleTemplateOptionsBotProtection
    Allows to prevent online services from overloading and ensure your business workflow running smoothly.
    brotliCompression GetCdnRuleTemplateOptionsBrotliCompression
    Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
    browserCacheSettings GetCdnRuleTemplateOptionsBrowserCacheSettings

    Cache expiration time for users browsers in seconds.

    Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.

    Responses with other codes will not be cached.

    cacheHttpHeaders GetCdnRuleTemplateOptionsCacheHttpHeaders

    Legacy option. Use the response_headers_hiding_policy option instead.

    HTTP Headers that must be included in the response.

    Deprecated: Deprecated

    cors GetCdnRuleTemplateOptionsCors

    Enables or disables CORS (Cross-Origin Resource Sharing) header support.

    CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.

    countryAcl GetCdnRuleTemplateOptionsCountryAcl
    Enables control access to content for specified countries.
    disableCache GetCdnRuleTemplateOptionsDisableCache

    Legacy option. Use the edge_cache_settings option instead.

    Allows the complete disabling of content caching.

    Deprecated: Deprecated

    disableProxyForceRanges GetCdnRuleTemplateOptionsDisableProxyForceRanges
    Allows 206 responses regardless of the settings of an origin source.
    edgeCacheSettings GetCdnRuleTemplateOptionsEdgeCacheSettings

    Cache expiration time for CDN servers.

    value and default fields cannot be used simultaneously.

    fastedge GetCdnRuleTemplateOptionsFastedge

    Allows to configure FastEdge app to be called on different request/response phases.

    Note: At least one of on_request_headers, on_request_body, on_response_headers, or on_response_body must be specified.

    fetchCompressed GetCdnRuleTemplateOptionsFetchCompressed

    Makes the CDN request compressed content from the origin.

    The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.

    Notes:

    1. fetch_compressed is not supported with gzipON or brotli_compression or slice options enabled.
    2. fetch_compressed overrides gzipON and brotli_compression in rule. If you enable it in CDN resource and want to use gzipON and brotli_compression in a rule, you have to specify "fetch_compressed": false in the rule.
    followOriginRedirect GetCdnRuleTemplateOptionsFollowOriginRedirect
    Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
    forceReturn GetCdnRuleTemplateOptionsForceReturn

    Applies custom HTTP response codes for CDN content.

    The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.

    forwardHostHeader GetCdnRuleTemplateOptionsForwardHostHeader

    Forwards the Host header from a end-user request to an origin server.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    gzipOn GetCdnRuleTemplateOptionsGzipOn

    Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.

    Notes:

    1. Compression with gzip is not supported with fetch_compressed or slice options enabled.
    2. fetch_compressed option in CDN resource settings overrides gzipON in rules. If you enable fetch_compressed in CDN resource and want to enable gzipON in rules, you need to specify "fetch_compressed":false for rules.
    hostHeader GetCdnRuleTemplateOptionsHostHeader

    Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.

    If the option is null, the Host Header value is equal to first CNAME.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    ignoreCookie GetCdnRuleTemplateOptionsIgnoreCookie
    Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
    ignoreQueryString GetCdnRuleTemplateOptionsIgnoreQueryString

    How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    imageStack GetCdnRuleTemplateOptionsImageStack
    Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
    ipAddressAcl GetCdnRuleTemplateOptionsIpAddressAcl

    Controls access to the CDN resource content for specific IP addresses.

    If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.

    We recommend you use a script for automatically update IP ACL. Read more.

    limitBandwidth GetCdnRuleTemplateOptionsLimitBandwidth
    Allows to control the download speed per connection.
    proxyCacheKey GetCdnRuleTemplateOptionsProxyCacheKey

    Allows you to modify your cache key. If omitted, the default value is $request_uri.

    Combine the specified variables to create a key for caching.

    • $request_uri
    • $scheme
    • $uri

    Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.

    proxyCacheMethodsSet GetCdnRuleTemplateOptionsProxyCacheMethodsSet
    Caching for POST requests along with default GET and HEAD.
    proxyConnectTimeout GetCdnRuleTemplateOptionsProxyConnectTimeout
    The time limit for establishing a connection with the origin.
    proxyReadTimeout GetCdnRuleTemplateOptionsProxyReadTimeout

    The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.

    Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).

    queryParamsBlacklist GetCdnRuleTemplateOptionsQueryParamsBlacklist

    Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    queryParamsWhitelist GetCdnRuleTemplateOptionsQueryParamsWhitelist

    Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    queryStringForwarding GetCdnRuleTemplateOptionsQueryStringForwarding
    The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
    redirectHttpToHttps GetCdnRuleTemplateOptionsRedirectHttpToHttps

    Enables redirect from HTTP to HTTPS.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    redirectHttpsToHttp GetCdnRuleTemplateOptionsRedirectHttpsToHttp

    Enables redirect from HTTPS to HTTP.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    referrerAcl GetCdnRuleTemplateOptionsReferrerAcl
    Controls access to the CDN resource content for specified domain names.
    requestLimiter GetCdnRuleTemplateOptionsRequestLimiter
    Option allows to limit the amount of HTTP requests.
    responseHeadersHidingPolicy GetCdnRuleTemplateOptionsResponseHeadersHidingPolicy
    Hides HTTP headers from an origin server in the CDN response.
    rewrite GetCdnRuleTemplateOptionsRewrite
    Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
    secureKey GetCdnRuleTemplateOptionsSecureKey
    Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
    slice GetCdnRuleTemplateOptionsSlice

    Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.

    The option is based on the Slice module.

    Notes:

    1. Origin must support HTTP Range requests.
    2. Not supported with gzipON, brotli_compression or fetch_compressed options enabled.
    sni GetCdnRuleTemplateOptionsSni

    The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.

    SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.

    The option works only if originProtocol parameter is HTTPS or MATCH.

    stale GetCdnRuleTemplateOptionsStale
    Serves stale cached content in case of origin unavailability.
    staticHeaders GetCdnRuleTemplateOptionsStaticHeaders

    Legacy option. Use the static_response_headers option instead.

    Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.

    Deprecated: Deprecated

    staticRequestHeaders GetCdnRuleTemplateOptionsStaticRequestHeaders
    Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
    staticResponseHeaders GetCdnRuleTemplateOptionsStaticResponseHeaders
    Custom HTTP Headers that a CDN server adds to a response.
    userAgentAcl GetCdnRuleTemplateOptionsUserAgentAcl
    Controls access to the content for specified User-Agents.
    waap GetCdnRuleTemplateOptionsWaap
    Allows to enable WAAP (Web Application and API Protection).
    websockets GetCdnRuleTemplateOptionsWebsockets
    Enables or disables WebSockets connections to an origin server.
    allowed_http_methods GetCdnRuleTemplateOptionsAllowedHttpMethods
    HTTP methods allowed for content requests from the CDN.
    bot_protection GetCdnRuleTemplateOptionsBotProtection
    Allows to prevent online services from overloading and ensure your business workflow running smoothly.
    brotli_compression GetCdnRuleTemplateOptionsBrotliCompression
    Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
    browser_cache_settings GetCdnRuleTemplateOptionsBrowserCacheSettings

    Cache expiration time for users browsers in seconds.

    Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.

    Responses with other codes will not be cached.

    cache_http_headers GetCdnRuleTemplateOptionsCacheHttpHeaders

    Legacy option. Use the response_headers_hiding_policy option instead.

    HTTP Headers that must be included in the response.

    Deprecated: Deprecated

    cors GetCdnRuleTemplateOptionsCors

    Enables or disables CORS (Cross-Origin Resource Sharing) header support.

    CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.

    country_acl GetCdnRuleTemplateOptionsCountryAcl
    Enables control access to content for specified countries.
    disable_cache GetCdnRuleTemplateOptionsDisableCache

    Legacy option. Use the edge_cache_settings option instead.

    Allows the complete disabling of content caching.

    Deprecated: Deprecated

    disable_proxy_force_ranges GetCdnRuleTemplateOptionsDisableProxyForceRanges
    Allows 206 responses regardless of the settings of an origin source.
    edge_cache_settings GetCdnRuleTemplateOptionsEdgeCacheSettings

    Cache expiration time for CDN servers.

    value and default fields cannot be used simultaneously.

    fastedge GetCdnRuleTemplateOptionsFastedge

    Allows to configure FastEdge app to be called on different request/response phases.

    Note: At least one of on_request_headers, on_request_body, on_response_headers, or on_response_body must be specified.

    fetch_compressed GetCdnRuleTemplateOptionsFetchCompressed

    Makes the CDN request compressed content from the origin.

    The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.

    Notes:

    1. fetch_compressed is not supported with gzipON or brotli_compression or slice options enabled.
    2. fetch_compressed overrides gzipON and brotli_compression in rule. If you enable it in CDN resource and want to use gzipON and brotli_compression in a rule, you have to specify "fetch_compressed": false in the rule.
    follow_origin_redirect GetCdnRuleTemplateOptionsFollowOriginRedirect
    Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
    force_return GetCdnRuleTemplateOptionsForceReturn

    Applies custom HTTP response codes for CDN content.

    The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.

    forward_host_header GetCdnRuleTemplateOptionsForwardHostHeader

    Forwards the Host header from a end-user request to an origin server.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    gzip_on GetCdnRuleTemplateOptionsGzipOn

    Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.

    Notes:

    1. Compression with gzip is not supported with fetch_compressed or slice options enabled.
    2. fetch_compressed option in CDN resource settings overrides gzipON in rules. If you enable fetch_compressed in CDN resource and want to enable gzipON in rules, you need to specify "fetch_compressed":false for rules.
    host_header GetCdnRuleTemplateOptionsHostHeader

    Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.

    If the option is null, the Host Header value is equal to first CNAME.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    ignore_cookie GetCdnRuleTemplateOptionsIgnoreCookie
    Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
    ignore_query_string GetCdnRuleTemplateOptionsIgnoreQueryString

    How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    image_stack GetCdnRuleTemplateOptionsImageStack
    Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
    ip_address_acl GetCdnRuleTemplateOptionsIpAddressAcl

    Controls access to the CDN resource content for specific IP addresses.

    If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.

    We recommend you use a script for automatically update IP ACL. Read more.

    limit_bandwidth GetCdnRuleTemplateOptionsLimitBandwidth
    Allows to control the download speed per connection.
    proxy_cache_key GetCdnRuleTemplateOptionsProxyCacheKey

    Allows you to modify your cache key. If omitted, the default value is $request_uri.

    Combine the specified variables to create a key for caching.

    • $request_uri
    • $scheme
    • $uri

    Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.

    proxy_cache_methods_set GetCdnRuleTemplateOptionsProxyCacheMethodsSet
    Caching for POST requests along with default GET and HEAD.
    proxy_connect_timeout GetCdnRuleTemplateOptionsProxyConnectTimeout
    The time limit for establishing a connection with the origin.
    proxy_read_timeout GetCdnRuleTemplateOptionsProxyReadTimeout

    The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.

    Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).

    query_params_blacklist GetCdnRuleTemplateOptionsQueryParamsBlacklist

    Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    query_params_whitelist GetCdnRuleTemplateOptionsQueryParamsWhitelist

    Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    query_string_forwarding GetCdnRuleTemplateOptionsQueryStringForwarding
    The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
    redirect_http_to_https GetCdnRuleTemplateOptionsRedirectHttpToHttps

    Enables redirect from HTTP to HTTPS.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    redirect_https_to_http GetCdnRuleTemplateOptionsRedirectHttpsToHttp

    Enables redirect from HTTPS to HTTP.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    referrer_acl GetCdnRuleTemplateOptionsReferrerAcl
    Controls access to the CDN resource content for specified domain names.
    request_limiter GetCdnRuleTemplateOptionsRequestLimiter
    Option allows to limit the amount of HTTP requests.
    response_headers_hiding_policy GetCdnRuleTemplateOptionsResponseHeadersHidingPolicy
    Hides HTTP headers from an origin server in the CDN response.
    rewrite GetCdnRuleTemplateOptionsRewrite
    Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
    secure_key GetCdnRuleTemplateOptionsSecureKey
    Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
    slice GetCdnRuleTemplateOptionsSlice

    Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.

    The option is based on the Slice module.

    Notes:

    1. Origin must support HTTP Range requests.
    2. Not supported with gzipON, brotli_compression or fetch_compressed options enabled.
    sni GetCdnRuleTemplateOptionsSni

    The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.

    SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.

    The option works only if originProtocol parameter is HTTPS or MATCH.

    stale GetCdnRuleTemplateOptionsStale
    Serves stale cached content in case of origin unavailability.
    static_headers GetCdnRuleTemplateOptionsStaticHeaders

    Legacy option. Use the static_response_headers option instead.

    Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.

    Deprecated: Deprecated

    static_request_headers GetCdnRuleTemplateOptionsStaticRequestHeaders
    Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
    static_response_headers GetCdnRuleTemplateOptionsStaticResponseHeaders
    Custom HTTP Headers that a CDN server adds to a response.
    user_agent_acl GetCdnRuleTemplateOptionsUserAgentAcl
    Controls access to the content for specified User-Agents.
    waap GetCdnRuleTemplateOptionsWaap
    Allows to enable WAAP (Web Application and API Protection).
    websockets GetCdnRuleTemplateOptionsWebsockets
    Enables or disables WebSockets connections to an origin server.
    allowedHttpMethods Property Map
    HTTP methods allowed for content requests from the CDN.
    botProtection Property Map
    Allows to prevent online services from overloading and ensure your business workflow running smoothly.
    brotliCompression Property Map
    Compresses content with Brotli on the CDN side. CDN servers will request only uncompressed content from the origin.
    browserCacheSettings Property Map

    Cache expiration time for users browsers in seconds.

    Cache expiration time is applied to the following response codes: 200, 201, 204, 206, 301, 302, 303, 304, 307, 308.

    Responses with other codes will not be cached.

    cacheHttpHeaders Property Map

    Legacy option. Use the response_headers_hiding_policy option instead.

    HTTP Headers that must be included in the response.

    Deprecated: Deprecated

    cors Property Map

    Enables or disables CORS (Cross-Origin Resource Sharing) header support.

    CORS header support allows the CDN to add the Access-Control-Allow-Origin header to a response to a browser.

    countryAcl Property Map
    Enables control access to content for specified countries.
    disableCache Property Map

    Legacy option. Use the edge_cache_settings option instead.

    Allows the complete disabling of content caching.

    Deprecated: Deprecated

    disableProxyForceRanges Property Map
    Allows 206 responses regardless of the settings of an origin source.
    edgeCacheSettings Property Map

    Cache expiration time for CDN servers.

    value and default fields cannot be used simultaneously.

    fastedge Property Map

    Allows to configure FastEdge app to be called on different request/response phases.

    Note: At least one of on_request_headers, on_request_body, on_response_headers, or on_response_body must be specified.

    fetchCompressed Property Map

    Makes the CDN request compressed content from the origin.

    The origin server should support compression. CDN servers will not decompress your content even if a user browser does not accept compression.

    Notes:

    1. fetch_compressed is not supported with gzipON or brotli_compression or slice options enabled.
    2. fetch_compressed overrides gzipON and brotli_compression in rule. If you enable it in CDN resource and want to use gzipON and brotli_compression in a rule, you have to specify "fetch_compressed": false in the rule.
    followOriginRedirect Property Map
    Enables redirection from origin. If the origin server returns a redirect, the option allows the CDN to pull the requested content from the origin server that was returned in the redirect.
    forceReturn Property Map

    Applies custom HTTP response codes for CDN content.

    The following codes are reserved by our system and cannot be specified in this option: 408, 444, 477, 494, 495, 496, 497, 499.

    forwardHostHeader Property Map

    Forwards the Host header from a end-user request to an origin server.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    gzipOn Property Map

    Compresses content with gzip on the CDN end. CDN servers will request only uncompressed content from the origin.

    Notes:

    1. Compression with gzip is not supported with fetch_compressed or slice options enabled.
    2. fetch_compressed option in CDN resource settings overrides gzipON in rules. If you enable fetch_compressed in CDN resource and want to enable gzipON in rules, you need to specify "fetch_compressed":false for rules.
    hostHeader Property Map

    Sets the Host header that CDN servers use when request content from an origin server. Your server must be able to process requests with the chosen header.

    If the option is null, the Host Header value is equal to first CNAME.

    hostHeader and forward_host_header options cannot be enabled simultaneously.

    ignoreCookie Property Map
    Defines whether the files with the Set-Cookies header are cached as one file or as different ones.
    ignoreQueryString Property Map

    How a file with different query strings is cached: either as one object (option is enabled) or as different objects (option is disabled.)

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    imageStack Property Map
    Transforms JPG and PNG images (for example, resize or crop) and automatically converts them to WebP or AVIF format.
    ipAddressAcl Property Map

    Controls access to the CDN resource content for specific IP addresses.

    If you want to use IPs from our CDN servers IP list for IP ACL configuration, you have to independently monitor their relevance.

    We recommend you use a script for automatically update IP ACL. Read more.

    limitBandwidth Property Map
    Allows to control the download speed per connection.
    proxyCacheKey Property Map

    Allows you to modify your cache key. If omitted, the default value is $request_uri.

    Combine the specified variables to create a key for caching.

    • $request_uri
    • $scheme
    • $uri

    Warning: Enabling and changing this option can invalidate your current cache and affect the cache hit ratio. Furthermore, the "Purge by pattern" option will not work.

    proxyCacheMethodsSet Property Map
    Caching for POST requests along with default GET and HEAD.
    proxyConnectTimeout Property Map
    The time limit for establishing a connection with the origin.
    proxyReadTimeout Property Map

    The time limit for receiving a partial response from the origin. If no response is received within this time, the connection will be closed.

    Note: When used with a WebSocket connection, this option supports values only in the range 1–20 seconds (instead of the usual 1–30 seconds).

    queryParamsBlacklist Property Map

    Files with the specified query parameters are cached as one object, files with other parameters are cached as different objects.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    queryParamsWhitelist Property Map

    Files with the specified query parameters are cached as different objects, files with other parameters are cached as one object.

    ignoreQueryString, query_params_whitelist and query_params_blacklist options cannot be enabled simultaneously.

    queryStringForwarding Property Map
    The Query String Forwarding feature allows for the seamless transfer of parameters embedded in playlist files to the corresponding media chunk files. This functionality ensures that specific attributes, such as authentication tokens or tracking information, are consistently passed along from the playlist manifest to the individual media segments. This is particularly useful for maintaining continuity in security, analytics, and any other parameter-based operations across the entire media delivery workflow.
    redirectHttpToHttps Property Map

    Enables redirect from HTTP to HTTPS.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    redirectHttpsToHttp Property Map

    Enables redirect from HTTPS to HTTP.

    redirect_http_to_https and redirect_https_to_http options cannot be enabled simultaneously.

    referrerAcl Property Map
    Controls access to the CDN resource content for specified domain names.
    requestLimiter Property Map
    Option allows to limit the amount of HTTP requests.
    responseHeadersHidingPolicy Property Map
    Hides HTTP headers from an origin server in the CDN response.
    rewrite Property Map
    Changes and redirects requests from the CDN to the origin. It operates according to the Nginx configuration.
    secureKey Property Map
    Configures access with tokenized URLs. This makes impossible to access content without a valid (unexpired) token.
    slice Property Map

    Requests and caches files larger than 10 MB in parts (no larger than 10 MB per part.) This reduces time to first byte.

    The option is based on the Slice module.

    Notes:

    1. Origin must support HTTP Range requests.
    2. Not supported with gzipON, brotli_compression or fetch_compressed options enabled.
    sni Property Map

    The hostname that is added to SNI requests from CDN servers to the origin server via HTTPS.

    SNI is generally only required if your origin uses shared hosting or does not have a dedicated IP address. If the origin server presents multiple certificates, SNI allows the origin server to know which certificate to use for the connection.

    The option works only if originProtocol parameter is HTTPS or MATCH.

    stale Property Map
    Serves stale cached content in case of origin unavailability.
    staticHeaders Property Map

    Legacy option. Use the static_response_headers option instead.

    Custom HTTP Headers that a CDN server adds to response. Up to fifty custom HTTP Headers can be specified. May contain a header with multiple values.

    Deprecated: Deprecated

    staticRequestHeaders Property Map
    Custom HTTP Headers for a CDN server to add to request. Up to fifty custom HTTP Headers can be specified.
    staticResponseHeaders Property Map
    Custom HTTP Headers that a CDN server adds to a response.
    userAgentAcl Property Map
    Controls access to the content for specified User-Agents.
    waap Property Map
    Allows to enable WAAP (Web Application and API Protection).
    websockets Property Map
    Enables or disables WebSockets connections to an origin server.

    GetCdnRuleTemplateOptionsAllowedHttpMethods

    Enabled bool
    Controls the option state.
    Values List<string>
    Enabled bool
    Controls the option state.
    Values []string
    enabled Boolean
    Controls the option state.
    values List<String>
    enabled boolean
    Controls the option state.
    values string[]
    enabled bool
    Controls the option state.
    values Sequence[str]
    enabled Boolean
    Controls the option state.
    values List<String>

    GetCdnRuleTemplateOptionsBotProtection

    BotChallenge GetCdnRuleTemplateOptionsBotProtectionBotChallenge
    Controls the bot challenge module state.
    Enabled bool
    Controls the option state.
    BotChallenge GetCdnRuleTemplateOptionsBotProtectionBotChallenge
    Controls the bot challenge module state.
    Enabled bool
    Controls the option state.
    botChallenge GetCdnRuleTemplateOptionsBotProtectionBotChallenge
    Controls the bot challenge module state.
    enabled Boolean
    Controls the option state.
    botChallenge GetCdnRuleTemplateOptionsBotProtectionBotChallenge
    Controls the bot challenge module state.
    enabled boolean
    Controls the option state.
    bot_challenge GetCdnRuleTemplateOptionsBotProtectionBotChallenge
    Controls the bot challenge module state.
    enabled bool
    Controls the option state.
    botChallenge Property Map
    Controls the bot challenge module state.
    enabled Boolean
    Controls the option state.

    GetCdnRuleTemplateOptionsBotProtectionBotChallenge

    Enabled bool
    Possible values:
    Enabled bool
    Possible values:
    enabled Boolean
    Possible values:
    enabled boolean
    Possible values:
    enabled bool
    Possible values:
    enabled Boolean
    Possible values:

    GetCdnRuleTemplateOptionsBrotliCompression

    Enabled bool
    Controls the option state.
    Values List<string>

    Allows to select the content types you want to compress.

    text/html is a mandatory content type.

    Enabled bool
    Controls the option state.
    Values []string

    Allows to select the content types you want to compress.

    text/html is a mandatory content type.

    enabled Boolean
    Controls the option state.
    values List<String>

    Allows to select the content types you want to compress.

    text/html is a mandatory content type.

    enabled boolean
    Controls the option state.
    values string[]

    Allows to select the content types you want to compress.

    text/html is a mandatory content type.

    enabled bool
    Controls the option state.
    values Sequence[str]

    Allows to select the content types you want to compress.

    text/html is a mandatory content type.

    enabled Boolean
    Controls the option state.
    values List<String>

    Allows to select the content types you want to compress.

    text/html is a mandatory content type.

    GetCdnRuleTemplateOptionsBrowserCacheSettings

    Enabled bool
    Controls the option state.
    Value string

    Set the cache expiration time to '0s' to disable caching.

    The maximum duration is any equivalent to 1y.

    Enabled bool
    Controls the option state.
    Value string

    Set the cache expiration time to '0s' to disable caching.

    The maximum duration is any equivalent to 1y.

    enabled Boolean
    Controls the option state.
    value String

    Set the cache expiration time to '0s' to disable caching.

    The maximum duration is any equivalent to 1y.

    enabled boolean
    Controls the option state.
    value string

    Set the cache expiration time to '0s' to disable caching.

    The maximum duration is any equivalent to 1y.

    enabled bool
    Controls the option state.
    value str

    Set the cache expiration time to '0s' to disable caching.

    The maximum duration is any equivalent to 1y.

    enabled Boolean
    Controls the option state.
    value String

    Set the cache expiration time to '0s' to disable caching.

    The maximum duration is any equivalent to 1y.

    GetCdnRuleTemplateOptionsCacheHttpHeaders

    Enabled bool
    Controls the option state.
    Values List<string>
    Enabled bool
    Controls the option state.
    Values []string
    enabled Boolean
    Controls the option state.
    values List<String>
    enabled boolean
    Controls the option state.
    values string[]
    enabled bool
    Controls the option state.
    values Sequence[str]
    enabled Boolean
    Controls the option state.
    values List<String>

    GetCdnRuleTemplateOptionsCors

    Always bool
    Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Values List<string>

    Value of the Access-Control-Allow-Origin header.

    Possible values:

    • Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain. "value": ["*"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field. "value": ["domain.com", "second.dom.com"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response. "value": ["$http_origin"]
    Always bool
    Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Values []string

    Value of the Access-Control-Allow-Origin header.

    Possible values:

    • Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain. "value": ["*"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field. "value": ["domain.com", "second.dom.com"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response. "value": ["$http_origin"]
    always Boolean
    Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    values List<String>

    Value of the Access-Control-Allow-Origin header.

    Possible values:

    • Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain. "value": ["*"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field. "value": ["domain.com", "second.dom.com"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response. "value": ["$http_origin"]
    always boolean
    Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
    enabled boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    values string[]

    Value of the Access-Control-Allow-Origin header.

    Possible values:

    • Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain. "value": ["*"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field. "value": ["domain.com", "second.dom.com"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response. "value": ["$http_origin"]
    always bool
    Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
    enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    values Sequence[str]

    Value of the Access-Control-Allow-Origin header.

    Possible values:

    • Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain. "value": ["*"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field. "value": ["domain.com", "second.dom.com"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response. "value": ["$http_origin"]
    always Boolean
    Defines whether the Access-Control-Allow-Origin header should be added to a response from CDN regardless of response code.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    values List<String>

    Value of the Access-Control-Allow-Origin header.

    Possible values:

    • Adds * as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain. "value": ["*"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value if the origin matches one of the listed domains - Content will be uploaded only for requests from the domains specified in the field. "value": ["domain.com", "second.dom.com"]
    • Adds "$http_origin" as the Access-Control-Allow-Origin header value - Content will be uploaded for requests from any domain, and the domain from which the request was sent will be added to the "Access-Control-Allow-Origin" header in the response. "value": ["$http_origin"]

    GetCdnRuleTemplateOptionsCountryAcl

    Enabled bool
    Controls the option state.
    ExceptedValues List<string>

    List of countries according to ISO-3166-1.

    The meaning of the parameter depends on policy_type value:

    • allow - List of countries for which access is prohibited.
    • deny - List of countries for which access is allowed.
    PolicyType string

    Defines the type of CDN resource access policy.

    Possible values:

    • allow - Access is allowed for all the countries except for those specified in excepted_values field.
    • deny - Access is denied for all the countries except for those specified in excepted_values field. Available values: "allow", "deny".
    Enabled bool
    Controls the option state.
    ExceptedValues []string

    List of countries according to ISO-3166-1.

    The meaning of the parameter depends on policy_type value:

    • allow - List of countries for which access is prohibited.
    • deny - List of countries for which access is allowed.
    PolicyType string

    Defines the type of CDN resource access policy.

    Possible values:

    • allow - Access is allowed for all the countries except for those specified in excepted_values field.
    • deny - Access is denied for all the countries except for those specified in excepted_values field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of countries according to ISO-3166-1.

    The meaning of the parameter depends on policy_type value:

    • allow - List of countries for which access is prohibited.
    • deny - List of countries for which access is allowed.
    policyType String

    Defines the type of CDN resource access policy.

    Possible values:

    • allow - Access is allowed for all the countries except for those specified in excepted_values field.
    • deny - Access is denied for all the countries except for those specified in excepted_values field. Available values: "allow", "deny".
    enabled boolean
    Controls the option state.
    exceptedValues string[]

    List of countries according to ISO-3166-1.

    The meaning of the parameter depends on policy_type value:

    • allow - List of countries for which access is prohibited.
    • deny - List of countries for which access is allowed.
    policyType string

    Defines the type of CDN resource access policy.

    Possible values:

    • allow - Access is allowed for all the countries except for those specified in excepted_values field.
    • deny - Access is denied for all the countries except for those specified in excepted_values field. Available values: "allow", "deny".
    enabled bool
    Controls the option state.
    excepted_values Sequence[str]

    List of countries according to ISO-3166-1.

    The meaning of the parameter depends on policy_type value:

    • allow - List of countries for which access is prohibited.
    • deny - List of countries for which access is allowed.
    policy_type str

    Defines the type of CDN resource access policy.

    Possible values:

    • allow - Access is allowed for all the countries except for those specified in excepted_values field.
    • deny - Access is denied for all the countries except for those specified in excepted_values field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of countries according to ISO-3166-1.

    The meaning of the parameter depends on policy_type value:

    • allow - List of countries for which access is prohibited.
    • deny - List of countries for which access is allowed.
    policyType String

    Defines the type of CDN resource access policy.

    Possible values:

    • allow - Access is allowed for all the countries except for those specified in excepted_values field.
    • deny - Access is denied for all the countries except for those specified in excepted_values field. Available values: "allow", "deny".

    GetCdnRuleTemplateOptionsDisableCache

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - content caching is disabled.
    • false - content caching is enabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - content caching is disabled.
    • false - content caching is enabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - content caching is disabled.
    • false - content caching is enabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - content caching is disabled.
    • false - content caching is enabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - content caching is disabled.
    • false - content caching is enabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - content caching is disabled.
    • false - content caching is enabled.

    GetCdnRuleTemplateOptionsDisableProxyForceRanges

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsEdgeCacheSettings

    CustomValues Dictionary<string, string>
    A MAP object representing the caching time in seconds for a response with a specific response code.
    Default string
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Value string

    Caching time.

    The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.

    Use 0s to disable caching.

    The maximum duration is any equivalent to 1y.

    CustomValues map[string]string
    A MAP object representing the caching time in seconds for a response with a specific response code.
    Default string
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Value string

    Caching time.

    The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.

    Use 0s to disable caching.

    The maximum duration is any equivalent to 1y.

    customValues Map<String,String>
    A MAP object representing the caching time in seconds for a response with a specific response code.
    default_ String
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    value String

    Caching time.

    The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.

    Use 0s to disable caching.

    The maximum duration is any equivalent to 1y.

    customValues {[key: string]: string}
    A MAP object representing the caching time in seconds for a response with a specific response code.
    default string
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    enabled boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    value string

    Caching time.

    The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.

    Use 0s to disable caching.

    The maximum duration is any equivalent to 1y.

    custom_values Mapping[str, str]
    A MAP object representing the caching time in seconds for a response with a specific response code.
    default str
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    value str

    Caching time.

    The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.

    Use 0s to disable caching.

    The maximum duration is any equivalent to 1y.

    customValues Map<String>
    A MAP object representing the caching time in seconds for a response with a specific response code.
    default String
    Defines whether the template is a system template developed for common cases. System templates are available to all customers.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    value String

    Caching time.

    The value is applied to the following response codes: 200, 206, 301, 302. Responses with codes 4xx, 5xx will not be cached.

    Use 0s to disable caching.

    The maximum duration is any equivalent to 1y.

    GetCdnRuleTemplateOptionsFastedge

    Enabled bool
    Controls the option state.
    OnRequestBody GetCdnRuleTemplateOptionsFastedgeOnRequestBody
    Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
    OnRequestHeaders GetCdnRuleTemplateOptionsFastedgeOnRequestHeaders
    Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
    OnResponseBody GetCdnRuleTemplateOptionsFastedgeOnResponseBody
    Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
    OnResponseHeaders GetCdnRuleTemplateOptionsFastedgeOnResponseHeaders
    Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
    Enabled bool
    Controls the option state.
    OnRequestBody GetCdnRuleTemplateOptionsFastedgeOnRequestBody
    Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
    OnRequestHeaders GetCdnRuleTemplateOptionsFastedgeOnRequestHeaders
    Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
    OnResponseBody GetCdnRuleTemplateOptionsFastedgeOnResponseBody
    Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
    OnResponseHeaders GetCdnRuleTemplateOptionsFastedgeOnResponseHeaders
    Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
    enabled Boolean
    Controls the option state.
    onRequestBody GetCdnRuleTemplateOptionsFastedgeOnRequestBody
    Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
    onRequestHeaders GetCdnRuleTemplateOptionsFastedgeOnRequestHeaders
    Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
    onResponseBody GetCdnRuleTemplateOptionsFastedgeOnResponseBody
    Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
    onResponseHeaders GetCdnRuleTemplateOptionsFastedgeOnResponseHeaders
    Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
    enabled boolean
    Controls the option state.
    onRequestBody GetCdnRuleTemplateOptionsFastedgeOnRequestBody
    Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
    onRequestHeaders GetCdnRuleTemplateOptionsFastedgeOnRequestHeaders
    Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
    onResponseBody GetCdnRuleTemplateOptionsFastedgeOnResponseBody
    Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
    onResponseHeaders GetCdnRuleTemplateOptionsFastedgeOnResponseHeaders
    Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
    enabled bool
    Controls the option state.
    on_request_body GetCdnRuleTemplateOptionsFastedgeOnRequestBody
    Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
    on_request_headers GetCdnRuleTemplateOptionsFastedgeOnRequestHeaders
    Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
    on_response_body GetCdnRuleTemplateOptionsFastedgeOnResponseBody
    Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
    on_response_headers GetCdnRuleTemplateOptionsFastedgeOnResponseHeaders
    Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.
    enabled Boolean
    Controls the option state.
    onRequestBody Property Map
    Allows to configure FastEdge application that will be called to handle request body as soon as CDN receives incoming HTTP request.
    onRequestHeaders Property Map
    Allows to configure FastEdge application that will be called to handle request headers as soon as CDN receives incoming HTTP request, before cache.
    onResponseBody Property Map
    Allows to configure FastEdge application that will be called to handle response body before CDN sends the HTTP response.
    onResponseHeaders Property Map
    Allows to configure FastEdge application that will be called to handle response headers before CDN sends the HTTP response.

    GetCdnRuleTemplateOptionsFastedgeOnRequestBody

    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.
    appId string
    The ID of the application in FastEdge.
    enabled boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError boolean
    Determines if the request execution should be interrupted when an error occurs.
    app_id str
    The ID of the application in FastEdge.
    enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    execute_on_edge bool
    Determines if the request should be executed at the edge nodes.
    execute_on_shield bool
    Determines if the request should be executed at the shield nodes.
    interrupt_on_error bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.

    GetCdnRuleTemplateOptionsFastedgeOnRequestHeaders

    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.
    appId string
    The ID of the application in FastEdge.
    enabled boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError boolean
    Determines if the request execution should be interrupted when an error occurs.
    app_id str
    The ID of the application in FastEdge.
    enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    execute_on_edge bool
    Determines if the request should be executed at the edge nodes.
    execute_on_shield bool
    Determines if the request should be executed at the shield nodes.
    interrupt_on_error bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.

    GetCdnRuleTemplateOptionsFastedgeOnResponseBody

    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.
    appId string
    The ID of the application in FastEdge.
    enabled boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError boolean
    Determines if the request execution should be interrupted when an error occurs.
    app_id str
    The ID of the application in FastEdge.
    enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    execute_on_edge bool
    Determines if the request should be executed at the edge nodes.
    execute_on_shield bool
    Determines if the request should be executed at the shield nodes.
    interrupt_on_error bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.

    GetCdnRuleTemplateOptionsFastedgeOnResponseHeaders

    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    AppId string
    The ID of the application in FastEdge.
    Enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    ExecuteOnEdge bool
    Determines if the request should be executed at the edge nodes.
    ExecuteOnShield bool
    Determines if the request should be executed at the shield nodes.
    InterruptOnError bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.
    appId string
    The ID of the application in FastEdge.
    enabled boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError boolean
    Determines if the request execution should be interrupted when an error occurs.
    app_id str
    The ID of the application in FastEdge.
    enabled bool
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    execute_on_edge bool
    Determines if the request should be executed at the edge nodes.
    execute_on_shield bool
    Determines if the request should be executed at the shield nodes.
    interrupt_on_error bool
    Determines if the request execution should be interrupted when an error occurs.
    appId String
    The ID of the application in FastEdge.
    enabled Boolean
    Determines if the FastEdge application should be called whenever HTTP request headers are received.
    executeOnEdge Boolean
    Determines if the request should be executed at the edge nodes.
    executeOnShield Boolean
    Determines if the request should be executed at the shield nodes.
    interruptOnError Boolean
    Determines if the request execution should be interrupted when an error occurs.

    GetCdnRuleTemplateOptionsFetchCompressed

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsFollowOriginRedirect

    Codes List<double>
    Redirect status code that the origin server returns.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Codes []float64
    Redirect status code that the origin server returns.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    codes List<Double>
    Redirect status code that the origin server returns.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    codes number[]
    Redirect status code that the origin server returns.
    enabled boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    codes Sequence[float]
    Redirect status code that the origin server returns.
    enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    codes List<Number>
    Redirect status code that the origin server returns.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsForceReturn

    Body string
    URL for redirection or text.
    Code double
    Status code value.
    Enabled bool
    Controls the option state.
    TimeInterval GetCdnRuleTemplateOptionsForceReturnTimeInterval
    Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
    Body string
    URL for redirection or text.
    Code float64
    Status code value.
    Enabled bool
    Controls the option state.
    TimeInterval GetCdnRuleTemplateOptionsForceReturnTimeInterval
    Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
    body String
    URL for redirection or text.
    code Double
    Status code value.
    enabled Boolean
    Controls the option state.
    timeInterval GetCdnRuleTemplateOptionsForceReturnTimeInterval
    Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
    body string
    URL for redirection or text.
    code number
    Status code value.
    enabled boolean
    Controls the option state.
    timeInterval GetCdnRuleTemplateOptionsForceReturnTimeInterval
    Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
    body str
    URL for redirection or text.
    code float
    Status code value.
    enabled bool
    Controls the option state.
    time_interval GetCdnRuleTemplateOptionsForceReturnTimeInterval
    Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.
    body String
    URL for redirection or text.
    code Number
    Status code value.
    enabled Boolean
    Controls the option state.
    timeInterval Property Map
    Controls the time at which a custom HTTP response code should be applied. By default, a custom HTTP response code is applied at any time.

    GetCdnRuleTemplateOptionsForceReturnTimeInterval

    EndTime string
    Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
    StartTime string
    Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
    TimeZone string
    Time zone used to calculate time.
    EndTime string
    Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
    StartTime string
    Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
    TimeZone string
    Time zone used to calculate time.
    endTime String
    Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
    startTime String
    Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
    timeZone String
    Time zone used to calculate time.
    endTime string
    Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
    startTime string
    Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
    timeZone string
    Time zone used to calculate time.
    end_time str
    Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
    start_time str
    Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
    time_zone str
    Time zone used to calculate time.
    endTime String
    Time until which a custom HTTP response code should be applied. Indicated in 24-hour format.
    startTime String
    Time from which a custom HTTP response code should be applied. Indicated in 24-hour format.
    timeZone String
    Time zone used to calculate time.

    GetCdnRuleTemplateOptionsForwardHostHeader

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsGzipOn

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsHostHeader

    Enabled bool
    Controls the option state.
    Value string
    Host Header value.
    Enabled bool
    Controls the option state.
    Value string
    Host Header value.
    enabled Boolean
    Controls the option state.
    value String
    Host Header value.
    enabled boolean
    Controls the option state.
    value string
    Host Header value.
    enabled bool
    Controls the option state.
    value str
    Host Header value.
    enabled Boolean
    Controls the option state.
    value String
    Host Header value.

    GetCdnRuleTemplateOptionsIgnoreCookie

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled, files with cookies are cached as one file.
    • false - Option is disabled, files with cookies are cached as different files.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled, files with cookies are cached as one file.
    • false - Option is disabled, files with cookies are cached as different files.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled, files with cookies are cached as one file.
    • false - Option is disabled, files with cookies are cached as different files.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled, files with cookies are cached as one file.
    • false - Option is disabled, files with cookies are cached as different files.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled, files with cookies are cached as one file.
    • false - Option is disabled, files with cookies are cached as different files.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled, files with cookies are cached as one file.
    • false - Option is disabled, files with cookies are cached as different files.

    GetCdnRuleTemplateOptionsIgnoreQueryString

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsImageStack

    AvifEnabled bool
    Enables or disables automatic conversion of JPEG and PNG images to AVI format.
    Enabled bool
    Controls the option state.
    PngLossless bool
    Enables or disables compression without quality loss for PNG format.
    Quality double
    Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
    WebpEnabled bool
    Enables or disables automatic conversion of JPEG and PNG images to WebP format.
    AvifEnabled bool
    Enables or disables automatic conversion of JPEG and PNG images to AVI format.
    Enabled bool
    Controls the option state.
    PngLossless bool
    Enables or disables compression without quality loss for PNG format.
    Quality float64
    Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
    WebpEnabled bool
    Enables or disables automatic conversion of JPEG and PNG images to WebP format.
    avifEnabled Boolean
    Enables or disables automatic conversion of JPEG and PNG images to AVI format.
    enabled Boolean
    Controls the option state.
    pngLossless Boolean
    Enables or disables compression without quality loss for PNG format.
    quality Double
    Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
    webpEnabled Boolean
    Enables or disables automatic conversion of JPEG and PNG images to WebP format.
    avifEnabled boolean
    Enables or disables automatic conversion of JPEG and PNG images to AVI format.
    enabled boolean
    Controls the option state.
    pngLossless boolean
    Enables or disables compression without quality loss for PNG format.
    quality number
    Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
    webpEnabled boolean
    Enables or disables automatic conversion of JPEG and PNG images to WebP format.
    avif_enabled bool
    Enables or disables automatic conversion of JPEG and PNG images to AVI format.
    enabled bool
    Controls the option state.
    png_lossless bool
    Enables or disables compression without quality loss for PNG format.
    quality float
    Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
    webp_enabled bool
    Enables or disables automatic conversion of JPEG and PNG images to WebP format.
    avifEnabled Boolean
    Enables or disables automatic conversion of JPEG and PNG images to AVI format.
    enabled Boolean
    Controls the option state.
    pngLossless Boolean
    Enables or disables compression without quality loss for PNG format.
    quality Number
    Defines quality settings for JPG and PNG images. The higher the value, the better the image quality, and the larger the file size after conversion.
    webpEnabled Boolean
    Enables or disables automatic conversion of JPEG and PNG images to WebP format.

    GetCdnRuleTemplateOptionsIpAddressAcl

    Enabled bool
    Controls the option state.
    ExceptedValues List<string>

    List of IP addresses with a subnet mask.

    The meaning of the parameter depends on policy_type value:

    • allow - List of IP addresses for which access is prohibited.
    • deny - List of IP addresses for which access is allowed.

    Examples:

    • 192.168.3.2/32
    • 2a03:d000:2980:7::8/128
    PolicyType string

    IP access policy type.

    Possible values:

    • allow - Allow access to all IPs except IPs specified in "excepted_values" field.
    • deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
    Enabled bool
    Controls the option state.
    ExceptedValues []string

    List of IP addresses with a subnet mask.

    The meaning of the parameter depends on policy_type value:

    • allow - List of IP addresses for which access is prohibited.
    • deny - List of IP addresses for which access is allowed.

    Examples:

    • 192.168.3.2/32
    • 2a03:d000:2980:7::8/128
    PolicyType string

    IP access policy type.

    Possible values:

    • allow - Allow access to all IPs except IPs specified in "excepted_values" field.
    • deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of IP addresses with a subnet mask.

    The meaning of the parameter depends on policy_type value:

    • allow - List of IP addresses for which access is prohibited.
    • deny - List of IP addresses for which access is allowed.

    Examples:

    • 192.168.3.2/32
    • 2a03:d000:2980:7::8/128
    policyType String

    IP access policy type.

    Possible values:

    • allow - Allow access to all IPs except IPs specified in "excepted_values" field.
    • deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
    enabled boolean
    Controls the option state.
    exceptedValues string[]

    List of IP addresses with a subnet mask.

    The meaning of the parameter depends on policy_type value:

    • allow - List of IP addresses for which access is prohibited.
    • deny - List of IP addresses for which access is allowed.

    Examples:

    • 192.168.3.2/32
    • 2a03:d000:2980:7::8/128
    policyType string

    IP access policy type.

    Possible values:

    • allow - Allow access to all IPs except IPs specified in "excepted_values" field.
    • deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
    enabled bool
    Controls the option state.
    excepted_values Sequence[str]

    List of IP addresses with a subnet mask.

    The meaning of the parameter depends on policy_type value:

    • allow - List of IP addresses for which access is prohibited.
    • deny - List of IP addresses for which access is allowed.

    Examples:

    • 192.168.3.2/32
    • 2a03:d000:2980:7::8/128
    policy_type str

    IP access policy type.

    Possible values:

    • allow - Allow access to all IPs except IPs specified in "excepted_values" field.
    • deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of IP addresses with a subnet mask.

    The meaning of the parameter depends on policy_type value:

    • allow - List of IP addresses for which access is prohibited.
    • deny - List of IP addresses for which access is allowed.

    Examples:

    • 192.168.3.2/32
    • 2a03:d000:2980:7::8/128
    policyType String

    IP access policy type.

    Possible values:

    • allow - Allow access to all IPs except IPs specified in "excepted_values" field.
    • deny - Deny access to all IPs except IPs specified in "excepted_values" field. Available values: "allow", "deny".

    GetCdnRuleTemplateOptionsLimitBandwidth

    Buffer double
    Amount of downloaded data after which the user will be rate limited.
    Enabled bool
    Controls the option state.
    LimitType string

    Method of controlling the download speed per connection.

    Possible values:

    • static - Use speed and buffer fields to set the download speed limit.
    • dynamic - Use query strings speed and buffer to set the download speed limit.

    For example, when requesting content at the link

    http://cdn.example.com/video.mp4?speed=50k&buffer=500k

    the download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".

    Speed double
    Maximum download speed per connection.
    Buffer float64
    Amount of downloaded data after which the user will be rate limited.
    Enabled bool
    Controls the option state.
    LimitType string

    Method of controlling the download speed per connection.

    Possible values:

    • static - Use speed and buffer fields to set the download speed limit.
    • dynamic - Use query strings speed and buffer to set the download speed limit.

    For example, when requesting content at the link

    http://cdn.example.com/video.mp4?speed=50k&buffer=500k

    the download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".

    Speed float64
    Maximum download speed per connection.
    buffer Double
    Amount of downloaded data after which the user will be rate limited.
    enabled Boolean
    Controls the option state.
    limitType String

    Method of controlling the download speed per connection.

    Possible values:

    • static - Use speed and buffer fields to set the download speed limit.
    • dynamic - Use query strings speed and buffer to set the download speed limit.

    For example, when requesting content at the link

    http://cdn.example.com/video.mp4?speed=50k&buffer=500k

    the download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".

    speed Double
    Maximum download speed per connection.
    buffer number
    Amount of downloaded data after which the user will be rate limited.
    enabled boolean
    Controls the option state.
    limitType string

    Method of controlling the download speed per connection.

    Possible values:

    • static - Use speed and buffer fields to set the download speed limit.
    • dynamic - Use query strings speed and buffer to set the download speed limit.

    For example, when requesting content at the link

    http://cdn.example.com/video.mp4?speed=50k&buffer=500k

    the download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".

    speed number
    Maximum download speed per connection.
    buffer float
    Amount of downloaded data after which the user will be rate limited.
    enabled bool
    Controls the option state.
    limit_type str

    Method of controlling the download speed per connection.

    Possible values:

    • static - Use speed and buffer fields to set the download speed limit.
    • dynamic - Use query strings speed and buffer to set the download speed limit.

    For example, when requesting content at the link

    http://cdn.example.com/video.mp4?speed=50k&buffer=500k

    the download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".

    speed float
    Maximum download speed per connection.
    buffer Number
    Amount of downloaded data after which the user will be rate limited.
    enabled Boolean
    Controls the option state.
    limitType String

    Method of controlling the download speed per connection.

    Possible values:

    • static - Use speed and buffer fields to set the download speed limit.
    • dynamic - Use query strings speed and buffer to set the download speed limit.

    For example, when requesting content at the link

    http://cdn.example.com/video.mp4?speed=50k&buffer=500k

    the download speed will be limited to 50kB/s after 500 kB. Available values: "static", "dynamic".

    speed Number
    Maximum download speed per connection.

    GetCdnRuleTemplateOptionsProxyCacheKey

    Enabled bool
    Controls the option state.
    Value string
    Key for caching.
    Enabled bool
    Controls the option state.
    Value string
    Key for caching.
    enabled Boolean
    Controls the option state.
    value String
    Key for caching.
    enabled boolean
    Controls the option state.
    value string
    Key for caching.
    enabled bool
    Controls the option state.
    value str
    Key for caching.
    enabled Boolean
    Controls the option state.
    value String
    Key for caching.

    GetCdnRuleTemplateOptionsProxyCacheMethodsSet

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsProxyConnectTimeout

    Enabled bool
    Controls the option state.
    Value string

    Timeout value in seconds.

    Supported range: 1s - 5s.

    Enabled bool
    Controls the option state.
    Value string

    Timeout value in seconds.

    Supported range: 1s - 5s.

    enabled Boolean
    Controls the option state.
    value String

    Timeout value in seconds.

    Supported range: 1s - 5s.

    enabled boolean
    Controls the option state.
    value string

    Timeout value in seconds.

    Supported range: 1s - 5s.

    enabled bool
    Controls the option state.
    value str

    Timeout value in seconds.

    Supported range: 1s - 5s.

    enabled Boolean
    Controls the option state.
    value String

    Timeout value in seconds.

    Supported range: 1s - 5s.

    GetCdnRuleTemplateOptionsProxyReadTimeout

    Enabled bool
    Controls the option state.
    Value string

    Timeout value in seconds.

    Supported range: 1s - 30s.

    Enabled bool
    Controls the option state.
    Value string

    Timeout value in seconds.

    Supported range: 1s - 30s.

    enabled Boolean
    Controls the option state.
    value String

    Timeout value in seconds.

    Supported range: 1s - 30s.

    enabled boolean
    Controls the option state.
    value string

    Timeout value in seconds.

    Supported range: 1s - 30s.

    enabled bool
    Controls the option state.
    value str

    Timeout value in seconds.

    Supported range: 1s - 30s.

    enabled Boolean
    Controls the option state.
    value String

    Timeout value in seconds.

    Supported range: 1s - 30s.

    GetCdnRuleTemplateOptionsQueryParamsBlacklist

    Enabled bool
    Controls the option state.
    Values List<string>
    List of query parameters.
    Enabled bool
    Controls the option state.
    Values []string
    List of query parameters.
    enabled Boolean
    Controls the option state.
    values List<String>
    List of query parameters.
    enabled boolean
    Controls the option state.
    values string[]
    List of query parameters.
    enabled bool
    Controls the option state.
    values Sequence[str]
    List of query parameters.
    enabled Boolean
    Controls the option state.
    values List<String>
    List of query parameters.

    GetCdnRuleTemplateOptionsQueryParamsWhitelist

    Enabled bool
    Controls the option state.
    Values List<string>
    List of query parameters.
    Enabled bool
    Controls the option state.
    Values []string
    List of query parameters.
    enabled Boolean
    Controls the option state.
    values List<String>
    List of query parameters.
    enabled boolean
    Controls the option state.
    values string[]
    List of query parameters.
    enabled bool
    Controls the option state.
    values Sequence[str]
    List of query parameters.
    enabled Boolean
    Controls the option state.
    values List<String>
    List of query parameters.

    GetCdnRuleTemplateOptionsQueryStringForwarding

    Enabled bool
    Controls the option state.
    ForwardExceptKeys List<string>
    The forward_except_keys field provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance.
    ForwardFromFileTypes List<string>
    The forward_from_files_types field specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference.
    ForwardOnlyKeys List<string>
    The forward_only_keys field allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
    ForwardToFileTypes List<string>
    The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
    Enabled bool
    Controls the option state.
    ForwardExceptKeys []string
    The forward_except_keys field provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance.
    ForwardFromFileTypes []string
    The forward_from_files_types field specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference.
    ForwardOnlyKeys []string
    The forward_only_keys field allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
    ForwardToFileTypes []string
    The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
    enabled Boolean
    Controls the option state.
    forwardExceptKeys List<String>
    The forward_except_keys field provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance.
    forwardFromFileTypes List<String>
    The forward_from_files_types field specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference.
    forwardOnlyKeys List<String>
    The forward_only_keys field allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
    forwardToFileTypes List<String>
    The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
    enabled boolean
    Controls the option state.
    forwardExceptKeys string[]
    The forward_except_keys field provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance.
    forwardFromFileTypes string[]
    The forward_from_files_types field specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference.
    forwardOnlyKeys string[]
    The forward_only_keys field allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
    forwardToFileTypes string[]
    The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
    enabled bool
    Controls the option state.
    forward_except_keys Sequence[str]
    The forward_except_keys field provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance.
    forward_from_file_types Sequence[str]
    The forward_from_files_types field specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference.
    forward_only_keys Sequence[str]
    The forward_only_keys field allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
    forward_to_file_types Sequence[str]
    The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.
    enabled Boolean
    Controls the option state.
    forwardExceptKeys List<String>
    The forward_except_keys field provides a mechanism to exclude specific parameters from being forwarded from playlist files to media chunk files. By listing certain keys in this field, you can ensure that these parameters are omitted during the forwarding process. This is particularly useful for preventing sensitive or irrelevant information from being included in requests for media chunks, thereby enhancing security and optimizing performance.
    forwardFromFileTypes List<String>
    The forward_from_files_types field specifies the types of playlist files from which parameters will be extracted and forwarded. This typically includes formats that list multiple media chunk references, such as HLS and DASH playlists. Parameters associated with these playlist files (like query strings or headers) will be propagated to the chunks they reference.
    forwardOnlyKeys List<String>
    The forward_only_keys field allows for granular control over which specific parameters are forwarded from playlist files to media chunk files. By specifying certain keys, only those parameters will be propagated, ensuring that only relevant information is passed along. This is particularly useful for security and performance optimization, as it prevents unnecessary or sensitive data from being included in requests for media chunks.
    forwardToFileTypes List<String>
    The field specifies the types of media chunk files to which parameters, extracted from playlist files, will be forwarded. These refer to the actual segments of media content that are delivered to viewers. Ensuring the correct parameters are forwarded to these files is crucial for maintaining the integrity of the streaming session.

    GetCdnRuleTemplateOptionsRedirectHttpToHttps

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsRedirectHttpsToHttp

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsReferrerAcl

    Enabled bool
    Controls the option state.
    ExceptedValues List<string>

    List of domain names or wildcard domains (without protocol: http:// or https://.)

    The meaning of the parameter depends on policy_type value:

    • allow - List of domain names for which access is prohibited.
    • deny - List of IP domain names for which access is allowed.

    Examples:

    • example.com
    • *.example.com
    PolicyType string

    Policy type.

    Possible values:

    • allow - Allow access to all domain names except the domain names specified in excepted_values field.
    • deny - Deny access to all domain names except the domain names specified in excepted_values field. Available values: "allow", "deny".
    Enabled bool
    Controls the option state.
    ExceptedValues []string

    List of domain names or wildcard domains (without protocol: http:// or https://.)

    The meaning of the parameter depends on policy_type value:

    • allow - List of domain names for which access is prohibited.
    • deny - List of IP domain names for which access is allowed.

    Examples:

    • example.com
    • *.example.com
    PolicyType string

    Policy type.

    Possible values:

    • allow - Allow access to all domain names except the domain names specified in excepted_values field.
    • deny - Deny access to all domain names except the domain names specified in excepted_values field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of domain names or wildcard domains (without protocol: http:// or https://.)

    The meaning of the parameter depends on policy_type value:

    • allow - List of domain names for which access is prohibited.
    • deny - List of IP domain names for which access is allowed.

    Examples:

    • example.com
    • *.example.com
    policyType String

    Policy type.

    Possible values:

    • allow - Allow access to all domain names except the domain names specified in excepted_values field.
    • deny - Deny access to all domain names except the domain names specified in excepted_values field. Available values: "allow", "deny".
    enabled boolean
    Controls the option state.
    exceptedValues string[]

    List of domain names or wildcard domains (without protocol: http:// or https://.)

    The meaning of the parameter depends on policy_type value:

    • allow - List of domain names for which access is prohibited.
    • deny - List of IP domain names for which access is allowed.

    Examples:

    • example.com
    • *.example.com
    policyType string

    Policy type.

    Possible values:

    • allow - Allow access to all domain names except the domain names specified in excepted_values field.
    • deny - Deny access to all domain names except the domain names specified in excepted_values field. Available values: "allow", "deny".
    enabled bool
    Controls the option state.
    excepted_values Sequence[str]

    List of domain names or wildcard domains (without protocol: http:// or https://.)

    The meaning of the parameter depends on policy_type value:

    • allow - List of domain names for which access is prohibited.
    • deny - List of IP domain names for which access is allowed.

    Examples:

    • example.com
    • *.example.com
    policy_type str

    Policy type.

    Possible values:

    • allow - Allow access to all domain names except the domain names specified in excepted_values field.
    • deny - Deny access to all domain names except the domain names specified in excepted_values field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of domain names or wildcard domains (without protocol: http:// or https://.)

    The meaning of the parameter depends on policy_type value:

    • allow - List of domain names for which access is prohibited.
    • deny - List of IP domain names for which access is allowed.

    Examples:

    • example.com
    • *.example.com
    policyType String

    Policy type.

    Possible values:

    • allow - Allow access to all domain names except the domain names specified in excepted_values field.
    • deny - Deny access to all domain names except the domain names specified in excepted_values field. Available values: "allow", "deny".

    GetCdnRuleTemplateOptionsRequestLimiter

    Burst double
    Delay double
    Enabled bool
    Controls the option state.
    Rate double
    Maximum request rate.
    RateUnit string

    Units of measurement for the rate field.

    Possible values:

    • r/s - Requests per second.
    • r/m - Requests per minute.

    If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".

    Burst float64
    Delay float64
    Enabled bool
    Controls the option state.
    Rate float64
    Maximum request rate.
    RateUnit string

    Units of measurement for the rate field.

    Possible values:

    • r/s - Requests per second.
    • r/m - Requests per minute.

    If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".

    burst Double
    delay Double
    enabled Boolean
    Controls the option state.
    rate Double
    Maximum request rate.
    rateUnit String

    Units of measurement for the rate field.

    Possible values:

    • r/s - Requests per second.
    • r/m - Requests per minute.

    If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".

    burst number
    delay number
    enabled boolean
    Controls the option state.
    rate number
    Maximum request rate.
    rateUnit string

    Units of measurement for the rate field.

    Possible values:

    • r/s - Requests per second.
    • r/m - Requests per minute.

    If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".

    burst float
    delay float
    enabled bool
    Controls the option state.
    rate float
    Maximum request rate.
    rate_unit str

    Units of measurement for the rate field.

    Possible values:

    • r/s - Requests per second.
    • r/m - Requests per minute.

    If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".

    burst Number
    delay Number
    enabled Boolean
    Controls the option state.
    rate Number
    Maximum request rate.
    rateUnit String

    Units of measurement for the rate field.

    Possible values:

    • r/s - Requests per second.
    • r/m - Requests per minute.

    If the rate is less than one request per second, it is specified in request per minute (r/m.) Available values: "r/s", "r/m".

    GetCdnRuleTemplateOptionsResponseHeadersHidingPolicy

    Enabled bool
    Controls the option state.
    Excepteds List<string>

    List of HTTP headers.

    Parameter meaning depends on the value of the mode field:

    • show - List of HTTP headers to hide from response.
    • hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.

    The following headers are required and cannot be hidden from response:

    • Connection
    • Content-Length
    • Content-Type
    • Date
    • Server
    Mode string

    How HTTP headers are hidden from the response.

    Possible values:

    • show - Hide only HTTP headers listed in the excepted field.
    • hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
    Enabled bool
    Controls the option state.
    Excepteds []string

    List of HTTP headers.

    Parameter meaning depends on the value of the mode field:

    • show - List of HTTP headers to hide from response.
    • hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.

    The following headers are required and cannot be hidden from response:

    • Connection
    • Content-Length
    • Content-Type
    • Date
    • Server
    Mode string

    How HTTP headers are hidden from the response.

    Possible values:

    • show - Hide only HTTP headers listed in the excepted field.
    • hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
    enabled Boolean
    Controls the option state.
    excepteds List<String>

    List of HTTP headers.

    Parameter meaning depends on the value of the mode field:

    • show - List of HTTP headers to hide from response.
    • hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.

    The following headers are required and cannot be hidden from response:

    • Connection
    • Content-Length
    • Content-Type
    • Date
    • Server
    mode String

    How HTTP headers are hidden from the response.

    Possible values:

    • show - Hide only HTTP headers listed in the excepted field.
    • hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
    enabled boolean
    Controls the option state.
    excepteds string[]

    List of HTTP headers.

    Parameter meaning depends on the value of the mode field:

    • show - List of HTTP headers to hide from response.
    • hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.

    The following headers are required and cannot be hidden from response:

    • Connection
    • Content-Length
    • Content-Type
    • Date
    • Server
    mode string

    How HTTP headers are hidden from the response.

    Possible values:

    • show - Hide only HTTP headers listed in the excepted field.
    • hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
    enabled bool
    Controls the option state.
    excepteds Sequence[str]

    List of HTTP headers.

    Parameter meaning depends on the value of the mode field:

    • show - List of HTTP headers to hide from response.
    • hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.

    The following headers are required and cannot be hidden from response:

    • Connection
    • Content-Length
    • Content-Type
    • Date
    • Server
    mode str

    How HTTP headers are hidden from the response.

    Possible values:

    • show - Hide only HTTP headers listed in the excepted field.
    • hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".
    enabled Boolean
    Controls the option state.
    excepteds List<String>

    List of HTTP headers.

    Parameter meaning depends on the value of the mode field:

    • show - List of HTTP headers to hide from response.
    • hide - List of HTTP headers to include in response. Other HTTP headers will be hidden.

    The following headers are required and cannot be hidden from response:

    • Connection
    • Content-Length
    • Content-Type
    • Date
    • Server
    mode String

    How HTTP headers are hidden from the response.

    Possible values:

    • show - Hide only HTTP headers listed in the excepted field.
    • hide - Hide all HTTP headers except headers listed in the "excepted" field. Available values: "hide", "show".

    GetCdnRuleTemplateOptionsRewrite

    Body string
    Path for the Rewrite option.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Flag string

    Flag for the Rewrite option.

    Possible values:

    • last - Stop processing the current set of ngx_http_rewrite_module directives and start a search for a new location matching changed URI.
    • break - Stop processing the current set of the Rewrite option.
    • redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with http://, https://, or $scheme.
    • permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
    Body string
    Path for the Rewrite option.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Flag string

    Flag for the Rewrite option.

    Possible values:

    • last - Stop processing the current set of ngx_http_rewrite_module directives and start a search for a new location matching changed URI.
    • break - Stop processing the current set of the Rewrite option.
    • redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with http://, https://, or $scheme.
    • permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
    body String
    Path for the Rewrite option.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    flag String

    Flag for the Rewrite option.

    Possible values:

    • last - Stop processing the current set of ngx_http_rewrite_module directives and start a search for a new location matching changed URI.
    • break - Stop processing the current set of the Rewrite option.
    • redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with http://, https://, or $scheme.
    • permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
    body string
    Path for the Rewrite option.
    enabled boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    flag string

    Flag for the Rewrite option.

    Possible values:

    • last - Stop processing the current set of ngx_http_rewrite_module directives and start a search for a new location matching changed URI.
    • break - Stop processing the current set of the Rewrite option.
    • redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with http://, https://, or $scheme.
    • permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
    body str
    Path for the Rewrite option.
    enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    flag str

    Flag for the Rewrite option.

    Possible values:

    • last - Stop processing the current set of ngx_http_rewrite_module directives and start a search for a new location matching changed URI.
    • break - Stop processing the current set of the Rewrite option.
    • redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with http://, https://, or $scheme.
    • permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".
    body String
    Path for the Rewrite option.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    flag String

    Flag for the Rewrite option.

    Possible values:

    • last - Stop processing the current set of ngx_http_rewrite_module directives and start a search for a new location matching changed URI.
    • break - Stop processing the current set of the Rewrite option.
    • redirect - Return a temporary redirect with the 302 code; used when a replacement string does not start with http://, https://, or $scheme.
    • permanent - Return a permanent redirect with the 301 code. Available values: "break", "last", "redirect", "permanent".

    GetCdnRuleTemplateOptionsSecureKey

    Enabled bool
    Controls the option state.
    Key string
    Key generated on your side that will be used for URL signing.
    Type double

    Type of URL signing.

    Possible types:

    • Type 0 - Includes end user IP to secure token generation.
    • Type 2 - Excludes end user IP from secure token generation. Available values: 0, 2.
    Enabled bool
    Controls the option state.
    Key string
    Key generated on your side that will be used for URL signing.
    Type float64

    Type of URL signing.

    Possible types:

    • Type 0 - Includes end user IP to secure token generation.
    • Type 2 - Excludes end user IP from secure token generation. Available values: 0, 2.
    enabled Boolean
    Controls the option state.
    key String
    Key generated on your side that will be used for URL signing.
    type Double

    Type of URL signing.

    Possible types:

    • Type 0 - Includes end user IP to secure token generation.
    • Type 2 - Excludes end user IP from secure token generation. Available values: 0, 2.
    enabled boolean
    Controls the option state.
    key string
    Key generated on your side that will be used for URL signing.
    type number

    Type of URL signing.

    Possible types:

    • Type 0 - Includes end user IP to secure token generation.
    • Type 2 - Excludes end user IP from secure token generation. Available values: 0, 2.
    enabled bool
    Controls the option state.
    key str
    Key generated on your side that will be used for URL signing.
    type float

    Type of URL signing.

    Possible types:

    • Type 0 - Includes end user IP to secure token generation.
    • Type 2 - Excludes end user IP from secure token generation. Available values: 0, 2.
    enabled Boolean
    Controls the option state.
    key String
    Key generated on your side that will be used for URL signing.
    type Number

    Type of URL signing.

    Possible types:

    • Type 0 - Includes end user IP to secure token generation.
    • Type 2 - Excludes end user IP from secure token generation. Available values: 0, 2.

    GetCdnRuleTemplateOptionsSlice

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsSni

    CustomHostname string
    Custom SNI hostname.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    SniType string

    SNI (Server Name Indication) type.

    Possible values:

    • dynamic - SNI hostname depends on hostHeader and forward_host_header options. It has several possible combinations:
    • If the hostHeader option is enabled and specified, SNI hostname matches the Host header.
    • If the forward_host_header option is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN.
    • If the hostHeader and forward_host_header options are disabled, SNI hostname matches the primary CNAME.
    • custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
    CustomHostname string
    Custom SNI hostname.
    Enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    SniType string

    SNI (Server Name Indication) type.

    Possible values:

    • dynamic - SNI hostname depends on hostHeader and forward_host_header options. It has several possible combinations:
    • If the hostHeader option is enabled and specified, SNI hostname matches the Host header.
    • If the forward_host_header option is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN.
    • If the hostHeader and forward_host_header options are disabled, SNI hostname matches the primary CNAME.
    • custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
    customHostname String
    Custom SNI hostname.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    sniType String

    SNI (Server Name Indication) type.

    Possible values:

    • dynamic - SNI hostname depends on hostHeader and forward_host_header options. It has several possible combinations:
    • If the hostHeader option is enabled and specified, SNI hostname matches the Host header.
    • If the forward_host_header option is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN.
    • If the hostHeader and forward_host_header options are disabled, SNI hostname matches the primary CNAME.
    • custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
    customHostname string
    Custom SNI hostname.
    enabled boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    sniType string

    SNI (Server Name Indication) type.

    Possible values:

    • dynamic - SNI hostname depends on hostHeader and forward_host_header options. It has several possible combinations:
    • If the hostHeader option is enabled and specified, SNI hostname matches the Host header.
    • If the forward_host_header option is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN.
    • If the hostHeader and forward_host_header options are disabled, SNI hostname matches the primary CNAME.
    • custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
    custom_hostname str
    Custom SNI hostname.
    enabled bool

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    sni_type str

    SNI (Server Name Indication) type.

    Possible values:

    • dynamic - SNI hostname depends on hostHeader and forward_host_header options. It has several possible combinations:
    • If the hostHeader option is enabled and specified, SNI hostname matches the Host header.
    • If the forward_host_header option is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN.
    • If the hostHeader and forward_host_header options are disabled, SNI hostname matches the primary CNAME.
    • custom - custom SNI hostname is in use. Available values: "dynamic", "custom".
    customHostname String
    Custom SNI hostname.
    enabled Boolean

    Controls the option state.

    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    sniType String

    SNI (Server Name Indication) type.

    Possible values:

    • dynamic - SNI hostname depends on hostHeader and forward_host_header options. It has several possible combinations:
    • If the hostHeader option is enabled and specified, SNI hostname matches the Host header.
    • If the forward_host_header option is enabled and has true value, SNI hostname matches the Host header used in the request made to a CDN.
    • If the hostHeader and forward_host_header options are disabled, SNI hostname matches the primary CNAME.
    • custom - custom SNI hostname is in use. Available values: "dynamic", "custom".

    GetCdnRuleTemplateOptionsStale

    Enabled bool
    Controls the option state.
    Values List<string>
    Defines list of errors for which "Always online" option is applied.
    Enabled bool
    Controls the option state.
    Values []string
    Defines list of errors for which "Always online" option is applied.
    enabled Boolean
    Controls the option state.
    values List<String>
    Defines list of errors for which "Always online" option is applied.
    enabled boolean
    Controls the option state.
    values string[]
    Defines list of errors for which "Always online" option is applied.
    enabled bool
    Controls the option state.
    values Sequence[str]
    Defines list of errors for which "Always online" option is applied.
    enabled Boolean
    Controls the option state.
    values List<String>
    Defines list of errors for which "Always online" option is applied.

    GetCdnRuleTemplateOptionsStaticHeaders

    Enabled bool
    Controls the option state.
    Value string

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    Enabled bool
    Controls the option state.
    Value string

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled Boolean
    Controls the option state.
    value String

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled boolean
    Controls the option state.
    value string

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled bool
    Controls the option state.
    value str

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled Boolean
    Controls the option state.
    value String

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 128 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.

    GetCdnRuleTemplateOptionsStaticRequestHeaders

    Enabled bool
    Controls the option state.
    Value Dictionary<string, string>

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    Enabled bool
    Controls the option state.
    Value map[string]string

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled Boolean
    Controls the option state.
    value Map<String,String>

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled boolean
    Controls the option state.
    value {[key: string]: string}

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled bool
    Controls the option state.
    value Mapping[str, str]

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.
    enabled Boolean
    Controls the option state.
    value Map<String>

    A MAP for static headers in a format of header_name: header_value.

    Restrictions:

    • Header name - Maximum 255 symbols, may contain Latin letters (A-Z, a-z), numbers (0-9), dashes, and underscores.
    • Header value - Maximum 512 symbols, may contain letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]). Must start with a letter, number, asterisk or {.

    GetCdnRuleTemplateOptionsStaticResponseHeaders

    enabled Boolean
    Controls the option state.
    values List<Property Map>

    GetCdnRuleTemplateOptionsStaticResponseHeadersValue

    Always bool
    Defines whether the header will be added to a response from CDN regardless of response code.
    Name string

    HTTP Header name.

    Restrictions:

    • Maximum 128 symbols.
    • Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
    Values List<string>

    Header value.

    Restrictions:

    • Maximum 512 symbols.
    • Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
    • Must start with a letter, number, asterisk or {.
    • Multiple values can be added.
    Always bool
    Defines whether the header will be added to a response from CDN regardless of response code.
    Name string

    HTTP Header name.

    Restrictions:

    • Maximum 128 symbols.
    • Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
    Values []string

    Header value.

    Restrictions:

    • Maximum 512 symbols.
    • Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
    • Must start with a letter, number, asterisk or {.
    • Multiple values can be added.
    always Boolean
    Defines whether the header will be added to a response from CDN regardless of response code.
    name String

    HTTP Header name.

    Restrictions:

    • Maximum 128 symbols.
    • Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
    values List<String>

    Header value.

    Restrictions:

    • Maximum 512 symbols.
    • Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
    • Must start with a letter, number, asterisk or {.
    • Multiple values can be added.
    always boolean
    Defines whether the header will be added to a response from CDN regardless of response code.
    name string

    HTTP Header name.

    Restrictions:

    • Maximum 128 symbols.
    • Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
    values string[]

    Header value.

    Restrictions:

    • Maximum 512 symbols.
    • Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
    • Must start with a letter, number, asterisk or {.
    • Multiple values can be added.
    always bool
    Defines whether the header will be added to a response from CDN regardless of response code.
    name str

    HTTP Header name.

    Restrictions:

    • Maximum 128 symbols.
    • Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
    values Sequence[str]

    Header value.

    Restrictions:

    • Maximum 512 symbols.
    • Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
    • Must start with a letter, number, asterisk or {.
    • Multiple values can be added.
    always Boolean
    Defines whether the header will be added to a response from CDN regardless of response code.
    name String

    HTTP Header name.

    Restrictions:

    • Maximum 128 symbols.
    • Latin letters (A-Z, a-z,) numbers (0-9,) dashes, and underscores only.
    values List<String>

    Header value.

    Restrictions:

    • Maximum 512 symbols.
    • Letters (a-z), numbers (0-9), spaces, and symbols (`~!@#%%^&*()-_=+ /|";:?.,><{}[]).
    • Must start with a letter, number, asterisk or {.
    • Multiple values can be added.

    GetCdnRuleTemplateOptionsUserAgentAcl

    Enabled bool
    Controls the option state.
    ExceptedValues List<string>

    List of User-Agents that will be allowed/denied.

    The meaning of the parameter depends on policy_type:

    • allow - List of User-Agents for which access is prohibited.
    • deny - List of User-Agents for which access is allowed.

    You can provide exact User-Agent strings or regular expressions. Regular expressions must start with ~ (case-sensitive) or ~* (case-insensitive).

    Use an empty string "" to allow/deny access when the User-Agent header is empty.

    PolicyType string

    User-Agents policy type.

    Possible values:

    • allow - Allow access for all User-Agents except specified in excepted_values field.
    • deny - Deny access for all User-Agents except specified in excepted_values field. Available values: "allow", "deny".
    Enabled bool
    Controls the option state.
    ExceptedValues []string

    List of User-Agents that will be allowed/denied.

    The meaning of the parameter depends on policy_type:

    • allow - List of User-Agents for which access is prohibited.
    • deny - List of User-Agents for which access is allowed.

    You can provide exact User-Agent strings or regular expressions. Regular expressions must start with ~ (case-sensitive) or ~* (case-insensitive).

    Use an empty string "" to allow/deny access when the User-Agent header is empty.

    PolicyType string

    User-Agents policy type.

    Possible values:

    • allow - Allow access for all User-Agents except specified in excepted_values field.
    • deny - Deny access for all User-Agents except specified in excepted_values field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of User-Agents that will be allowed/denied.

    The meaning of the parameter depends on policy_type:

    • allow - List of User-Agents for which access is prohibited.
    • deny - List of User-Agents for which access is allowed.

    You can provide exact User-Agent strings or regular expressions. Regular expressions must start with ~ (case-sensitive) or ~* (case-insensitive).

    Use an empty string "" to allow/deny access when the User-Agent header is empty.

    policyType String

    User-Agents policy type.

    Possible values:

    • allow - Allow access for all User-Agents except specified in excepted_values field.
    • deny - Deny access for all User-Agents except specified in excepted_values field. Available values: "allow", "deny".
    enabled boolean
    Controls the option state.
    exceptedValues string[]

    List of User-Agents that will be allowed/denied.

    The meaning of the parameter depends on policy_type:

    • allow - List of User-Agents for which access is prohibited.
    • deny - List of User-Agents for which access is allowed.

    You can provide exact User-Agent strings or regular expressions. Regular expressions must start with ~ (case-sensitive) or ~* (case-insensitive).

    Use an empty string "" to allow/deny access when the User-Agent header is empty.

    policyType string

    User-Agents policy type.

    Possible values:

    • allow - Allow access for all User-Agents except specified in excepted_values field.
    • deny - Deny access for all User-Agents except specified in excepted_values field. Available values: "allow", "deny".
    enabled bool
    Controls the option state.
    excepted_values Sequence[str]

    List of User-Agents that will be allowed/denied.

    The meaning of the parameter depends on policy_type:

    • allow - List of User-Agents for which access is prohibited.
    • deny - List of User-Agents for which access is allowed.

    You can provide exact User-Agent strings or regular expressions. Regular expressions must start with ~ (case-sensitive) or ~* (case-insensitive).

    Use an empty string "" to allow/deny access when the User-Agent header is empty.

    policy_type str

    User-Agents policy type.

    Possible values:

    • allow - Allow access for all User-Agents except specified in excepted_values field.
    • deny - Deny access for all User-Agents except specified in excepted_values field. Available values: "allow", "deny".
    enabled Boolean
    Controls the option state.
    exceptedValues List<String>

    List of User-Agents that will be allowed/denied.

    The meaning of the parameter depends on policy_type:

    • allow - List of User-Agents for which access is prohibited.
    • deny - List of User-Agents for which access is allowed.

    You can provide exact User-Agent strings or regular expressions. Regular expressions must start with ~ (case-sensitive) or ~* (case-insensitive).

    Use an empty string "" to allow/deny access when the User-Agent header is empty.

    policyType String

    User-Agents policy type.

    Possible values:

    • allow - Allow access for all User-Agents except specified in excepted_values field.
    • deny - Deny access for all User-Agents except specified in excepted_values field. Available values: "allow", "deny".

    GetCdnRuleTemplateOptionsWaap

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    GetCdnRuleTemplateOptionsWebsockets

    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    Enabled bool
    Controls the option state.
    Value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled boolean
    Controls the option state.
    value boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled bool
    Controls the option state.
    value bool
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.
    enabled Boolean
    Controls the option state.
    value Boolean
    Possible values:

    • true - Option is enabled.
    • false - Option is disabled.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    Viewing docs for gcore 2.0.0-alpha.3
    published on Monday, Mar 30, 2026 by g-core
    Schema (JSON)
    g-core/terraform-provider-gcore
      Try Pulumi Cloud free. Your team will thank you.