GET CDN cache rule.

GET

/api/config/namespaces/{namespace}/cdn_cache_rules/{name}

curl --request GET \
  --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/cdn_cache_rules/example?response_format=GET_RSP_FORMAT_DEFAULT' \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

Shape of the CDN loadbalancer specification.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace The namespace in which the configuration object is present.

name

required

string

Name The name of the configuration object to be fetched.

Query Parameters

response_format

string

default: GET_RSP_FORMAT_DEFAULT

Allowed values: GET_RSP_FORMAT_DEFAULT GET_RSP_FORMAT_FOR_CREATE GET_RSP_FORMAT_FOR_REPLACE GET_RSP_FORMAT_READ GET_RSP_FORMAT_REFERRING_OBJECTS GET_RSP_FORMAT_BROKEN_REFERENCES

The format in which the configuration object is to be fetched. This could be for example

• in GetSpec form for the contents of object
• in CreateRequest form to create a new similar object
• to ReplaceRequest form to replace changeable values

Default format of returned resource Response should be in CreateRequest format Response should be in ReplaceRequest format Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object.

Responses

200

A successful response.

Media typeapplication/json

GetResponse is the shape of a read cdn_cache_rule

This is the output message of the ‘GET’ RPC.

object

create_form

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

spec

object

cache_rules

object

cache_bypass

object

eligible_for_cache

object

scheme_proxy_host_request_uri

object

cache_override

Cache Override

Honour Cache Override.

boolean format: boolean

cache_ttl

Cache TTL Key

Cache TTL value is used to cache the resource/content for the specified amount of time Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Required: YES.

string

<= 1024 characters

ignore_response_cookie

Set Cookie

By default, response will not be cached if set-cookie header is present. This option will override the behavior and cache response even with set-cookie header present.

boolean format: boolean

scheme_proxy_host_uri

object

cache_override

Cache Override

Honour Cache Override.

boolean format: boolean

cache_ttl

Cache TTL Key

Cache TTL value is used to cache the resource/content for the specified amount of time Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Required: YES.

string

<= 1024 characters

ignore_response_cookie

Set Cookie

By default, response will not be cached if set-cookie header is present. This option will override the behavior and cache response even with set-cookie header present.

boolean format: boolean

rule_expression_list

Expression List

Expressions are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs..

Required: YES.

Array<object>

>= 1 items <= 8 items

Cache Rule Expression List

CDN Cache Rule Expressions.

object

cache_rule_expression

Terms

The Cache Rule Expression Terms that are ANDed

Required: YES.

Array<object>

>= 1 items <= 8 items

CDNCacheRuleExpression

Select one of the field OPTIONS.

object

cache_headers

Cache Headers

Configure cache rule headers to match the criteria.

Array<object>

<= 8 items

CacheHeaderMatcherType

Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header

Header Match can also be inverse of above, which be used to check missing header or non-matching value.

object

name

string

default: PROXY_HOST

Allowed values: PROXY_HOST REFERER SCHEME USER_AGENT

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

cookie_matcher

cookie matchers

A list of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances of CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name. Note that all specified cookie matcher predicates must evaluate to true.

Array<object>

<= 8 items

CacheCookieMatcherType

A cookie matcher specifies the name of a single cookie and the criteria to match it. The input has a list of values for each cookie in the request. A cookie matcher can check for one of the following:

• Presence or absence of the cookie
• At least one of the values for the cookie in the request satisfies the MatcherType item.

object

name

name

A case-sensitive cookie name. Required: YES.

string

>= 6 characters <= 256 characters

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

path_match

object

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

query_parameters

query_params

List of (key, value) query parameters.

Array<object>

<= 8 items

CacheQueryParameterMatcherType

Query parameter match can be either regex match on value or exact match of value for given key An example for HTTP request with query parameter https://gitlab.com/dashboard/issues?assignee_username=xxyyxx.

object

key

key

Query parameter key In the above example, assignee_username is the key Required: YES.

string

>= 1 characters <= 256 characters

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

expression_name

Expression Name

Name of the Expressions items that are ANDed Required: YES.

string

<= 128 characters

rule_name

Rule Name

Name of the Cache Rule Required: YES.

string

<= 128 characters

deleted_referred_objects

deleted_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

disabled_referred_objects

disabled_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

referring_objects

referring_objects

The set of objects that are referring to this object in their spec.

Array<object>

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

replace_form

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

spec

object

cache_rules

object

cache_bypass

object

eligible_for_cache

object

scheme_proxy_host_request_uri

object

cache_override

Cache Override

Honour Cache Override.

boolean format: boolean

cache_ttl

Cache TTL Key

Cache TTL value is used to cache the resource/content for the specified amount of time Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Required: YES.

string

<= 1024 characters

ignore_response_cookie

Set Cookie

By default, response will not be cached if set-cookie header is present. This option will override the behavior and cache response even with set-cookie header present.

boolean format: boolean

scheme_proxy_host_uri

object

cache_override

Cache Override

Honour Cache Override.

boolean format: boolean

cache_ttl

Cache TTL Key

Cache TTL value is used to cache the resource/content for the specified amount of time Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Required: YES.

string

<= 1024 characters

ignore_response_cookie

Set Cookie

By default, response will not be cached if set-cookie header is present. This option will override the behavior and cache response even with set-cookie header present.

boolean format: boolean

rule_expression_list

Expression List

Expressions are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs..

Required: YES.

Array<object>

>= 1 items <= 8 items

Cache Rule Expression List

CDN Cache Rule Expressions.

object

cache_rule_expression

Terms

The Cache Rule Expression Terms that are ANDed

Required: YES.

Array<object>

>= 1 items <= 8 items

CDNCacheRuleExpression

Select one of the field OPTIONS.

object

cache_headers

Cache Headers

Configure cache rule headers to match the criteria.

Array<object>

<= 8 items

CacheHeaderMatcherType

Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header

Header Match can also be inverse of above, which be used to check missing header or non-matching value.

object

name

string

default: PROXY_HOST

Allowed values: PROXY_HOST REFERER SCHEME USER_AGENT

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

cookie_matcher

cookie matchers

A list of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances of CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name. Note that all specified cookie matcher predicates must evaluate to true.

Array<object>

<= 8 items

CacheCookieMatcherType

A cookie matcher specifies the name of a single cookie and the criteria to match it. The input has a list of values for each cookie in the request. A cookie matcher can check for one of the following:

• Presence or absence of the cookie
• At least one of the values for the cookie in the request satisfies the MatcherType item.

object

name

name

A case-sensitive cookie name. Required: YES.

string

>= 6 characters <= 256 characters

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

path_match

object

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

query_parameters

query_params

List of (key, value) query parameters.

Array<object>

<= 8 items

CacheQueryParameterMatcherType

Query parameter match can be either regex match on value or exact match of value for given key An example for HTTP request with query parameter https://gitlab.com/dashboard/issues?assignee_username=xxyyxx.

object

key

key

Query parameter key In the above example, assignee_username is the key Required: YES.

string

>= 1 characters <= 256 characters

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

expression_name

Expression Name

Name of the Expressions items that are ANDed Required: YES.

string

<= 128 characters

rule_name

Rule Name

Name of the Cache Rule Required: YES.

string

<= 128 characters

spec

object

cache_rules

object

cache_bypass

object

eligible_for_cache

object

scheme_proxy_host_request_uri

object

cache_override

Cache Override

Honour Cache Override.

boolean format: boolean

cache_ttl

Cache TTL Key

Cache TTL value is used to cache the resource/content for the specified amount of time Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Required: YES.

string

<= 1024 characters

ignore_response_cookie

Set Cookie

By default, response will not be cached if set-cookie header is present. This option will override the behavior and cache response even with set-cookie header present.

boolean format: boolean

scheme_proxy_host_uri

object

cache_override

Cache Override

Honour Cache Override.

boolean format: boolean

cache_ttl

Cache TTL Key

Cache TTL value is used to cache the resource/content for the specified amount of time Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days Required: YES.

string

<= 1024 characters

ignore_response_cookie

Set Cookie

By default, response will not be cached if set-cookie header is present. This option will override the behavior and cache response even with set-cookie header present.

boolean format: boolean

rule_expression_list

Expression List

Expressions are evaluated in the order in which they are specified. The evaluation stops when the first rule match occurs..

Required: YES.

Array<object>

>= 1 items <= 8 items

Cache Rule Expression List

CDN Cache Rule Expressions.

object

cache_rule_expression

Terms

The Cache Rule Expression Terms that are ANDed

Required: YES.

Array<object>

>= 1 items <= 8 items

CDNCacheRuleExpression

Select one of the field OPTIONS.

object

cache_headers

Cache Headers

Configure cache rule headers to match the criteria.

Array<object>

<= 8 items

CacheHeaderMatcherType

Header match is done using the name of the header and its value. The value match is done using one of the following regex match on value exact match of value presence of header

Header Match can also be inverse of above, which be used to check missing header or non-matching value.

object

name

string

default: PROXY_HOST

Allowed values: PROXY_HOST REFERER SCHEME USER_AGENT

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

cookie_matcher

cookie matchers

A list of predicates for all cookies that need to be matched. The criteria for matching each cookie is described in individual instances of CookieMatcherType. The actual cookie values are extracted from the request API as a list of strings for each cookie name. Note that all specified cookie matcher predicates must evaluate to true.

Array<object>

<= 8 items

CacheCookieMatcherType

A cookie matcher specifies the name of a single cookie and the criteria to match it. The input has a list of values for each cookie in the request. A cookie matcher can check for one of the following:

• Presence or absence of the cookie
• At least one of the values for the cookie in the request satisfies the MatcherType item.

object

name

name

A case-sensitive cookie name. Required: YES.

string

>= 6 characters <= 256 characters

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

path_match

object

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

query_parameters

query_params

List of (key, value) query parameters.

Array<object>

<= 8 items

CacheQueryParameterMatcherType

Query parameter match can be either regex match on value or exact match of value for given key An example for HTTP request with query parameter https://gitlab.com/dashboard/issues?assignee_username=xxyyxx.

object

key

key

Query parameter key In the above example, assignee_username is the key Required: YES.

string

>= 1 characters <= 256 characters

operator

object

Contains

Contains

Exclusive with [DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must contain.

string

<= 1024 characters

DoesNotContain

Does Not Contain

Exclusive with [Contains DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not contain.

string

<= 1024 characters

DoesNotEndWith

Does Not End With

Exclusive with [Contains DoesNotContain DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not end with.

string

<= 1024 characters

DoesNotEqual

Does Not Equal

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotStartWith Endswith Equals MatchRegex Startswith] Field must not equal.

string

<= 1024 characters

DoesNotStartWith

Does Not Start With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual Endswith Equals MatchRegex Startswith] Field must not start with.

string

<= 1024 characters

Endswith

Ends With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Equals MatchRegex Startswith] Field must end with.

string

<= 1024 characters

Equals

Equals

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith MatchRegex Startswith] Field must exactly match.

string

<= 1024 characters

MatchRegex

Matches Regex

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals Startswith] Field matches PCRE 1 compliant regular expression.

string

>= 1 characters <= 256 characters

Startswith

Starts With

Exclusive with [Contains DoesNotContain DoesNotEndWith DoesNotEqual DoesNotStartWith Endswith Equals MatchRegex] Field must start with.

string

<= 1024 characters

expression_name

Expression Name

Name of the Expressions items that are ANDed Required: YES.

string

<= 128 characters

rule_name

Rule Name

Name of the Cache Rule Required: YES.

string

<= 128 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "create_form": {
    "spec": {
      "cache_rules": {
        "rule_expression_list": [
          {
            "cache_rule_expression": [
              {
                "cache_headers": [
                  {
                    "name": "PROXY_HOST"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "replace_form": {
    "spec": {
      "cache_rules": {
        "rule_expression_list": [
          {
            "cache_rule_expression": [
              {
                "cache_headers": [
                  {
                    "name": "PROXY_HOST"
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  },
  "spec": {
    "cache_rules": {
      "rule_expression_list": [
        {
          "cache_rule_expression": [
            {
              "cache_headers": [
                {
                  "name": "PROXY_HOST"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example