1. Docs
  2. Reference
  3. API
  4. @pulumi/cloudflare
  5. types
  6. output

Module types/output

APIs

APIs

interface AccessGroupExclude

interface AccessGroupExclude

property anyValidServiceToken

anyValidServiceToken?: undefined | false | true;

property azures

azures?: AccessGroupExcludeAzure[];

property certificate

certificate?: undefined | false | true;

property commonName

commonName?: undefined | string;

property emailDomains

emailDomains?: string[];

property emails

emails?: string[];

property everyone

everyone?: undefined | false | true;

property githubs

githubs?: AccessGroupExcludeGithub[];

property groups

groups?: string[];

property gsuites

gsuites?: AccessGroupExcludeGsuite[];

property ips

ips?: string[];

property oktas

oktas?: AccessGroupExcludeOkta[];

property samls

samls?: AccessGroupExcludeSaml[];

property serviceTokens

serviceTokens?: string[];

interface AccessGroupExcludeAzure

interface AccessGroupExcludeAzure

property id

id?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupExcludeGithub

interface AccessGroupExcludeGithub

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Group.

interface AccessGroupExcludeGsuite

interface AccessGroupExcludeGsuite

property email

email?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupExcludeOkta

interface AccessGroupExcludeOkta

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Group.

interface AccessGroupExcludeSaml

interface AccessGroupExcludeSaml

property attributeName

attributeName?: undefined | string;

property attributeValue

attributeValue?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupInclude

interface AccessGroupInclude

property anyValidServiceToken

anyValidServiceToken?: undefined | false | true;

property azures

azures?: AccessGroupIncludeAzure[];

property certificate

certificate?: undefined | false | true;

property commonName

commonName?: undefined | string;

property emailDomains

emailDomains?: string[];

property emails

emails?: string[];

property everyone

everyone?: undefined | false | true;

property githubs

githubs?: AccessGroupIncludeGithub[];

property groups

groups?: string[];

property gsuites

gsuites?: AccessGroupIncludeGsuite[];

property ips

ips?: string[];

property oktas

oktas?: AccessGroupIncludeOkta[];

property samls

samls?: AccessGroupIncludeSaml[];

property serviceTokens

serviceTokens?: string[];

interface AccessGroupIncludeAzure

interface AccessGroupIncludeAzure

property id

id?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupIncludeGithub

interface AccessGroupIncludeGithub

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Group.

interface AccessGroupIncludeGsuite

interface AccessGroupIncludeGsuite

property email

email?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupIncludeOkta

interface AccessGroupIncludeOkta

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Group.

interface AccessGroupIncludeSaml

interface AccessGroupIncludeSaml

property attributeName

attributeName?: undefined | string;

property attributeValue

attributeValue?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupRequire

interface AccessGroupRequire

property anyValidServiceToken

anyValidServiceToken?: undefined | false | true;

property azures

azures?: AccessGroupRequireAzure[];

property certificate

certificate?: undefined | false | true;

property commonName

commonName?: undefined | string;

property emailDomains

emailDomains?: string[];

property emails

emails?: string[];

property everyone

everyone?: undefined | false | true;

property githubs

githubs?: AccessGroupRequireGithub[];

property groups

groups?: string[];

property gsuites

gsuites?: AccessGroupRequireGsuite[];

property ips

ips?: string[];

property oktas

oktas?: AccessGroupRequireOkta[];

property samls

samls?: AccessGroupRequireSaml[];

property serviceTokens

serviceTokens?: string[];

interface AccessGroupRequireAzure

interface AccessGroupRequireAzure

property id

id?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupRequireGithub

interface AccessGroupRequireGithub

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Group.

interface AccessGroupRequireGsuite

interface AccessGroupRequireGsuite

property email

email?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessGroupRequireOkta

interface AccessGroupRequireOkta

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Group.

interface AccessGroupRequireSaml

interface AccessGroupRequireSaml

property attributeName

attributeName?: undefined | string;

property attributeValue

attributeValue?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessIdentityProviderConfig

interface AccessIdentityProviderConfig

property appsDomain

appsDomain?: undefined | string;

property attributes

attributes?: string[];

property authUrl

authUrl?: undefined | string;

property centrifyAccount

centrifyAccount?: undefined | string;

property centrifyAppId

centrifyAppId?: undefined | string;

property certsUrl

certsUrl?: undefined | string;

property clientId

clientId?: undefined | string;

property clientSecret

clientSecret?: undefined | string;

property directoryId

directoryId?: undefined | string;

property emailAttributeName

emailAttributeName?: undefined | string;

property idpPublicCert

idpPublicCert?: undefined | string;

property issuerUrl

issuerUrl?: undefined | string;

property oktaAccount

oktaAccount?: undefined | string;

property oneloginAccount

oneloginAccount?: undefined | string;

property redirectUrl

redirectUrl: string;

property signRequest

signRequest?: undefined | false | true;

property ssoTargetUrl

ssoTargetUrl?: undefined | string;

property supportGroups

supportGroups?: undefined | false | true;

property tokenUrl

tokenUrl?: undefined | string;

interface AccessPolicyExclude

interface AccessPolicyExclude

property anyValidServiceToken

anyValidServiceToken?: undefined | false | true;

property azures

azures?: AccessPolicyExcludeAzure[];

property certificate

certificate?: undefined | false | true;

property commonName

commonName?: undefined | string;

property emailDomains

emailDomains?: string[];

property emails

emails?: string[];

property everyone

everyone?: undefined | false | true;

property githubs

githubs?: AccessPolicyExcludeGithub[];

property groups

groups?: string[];

property gsuites

gsuites?: AccessPolicyExcludeGsuite[];

property ips

ips?: string[];

property oktas

oktas?: AccessPolicyExcludeOkta[];

property samls

samls?: AccessPolicyExcludeSaml[];

property serviceTokens

serviceTokens?: string[];

interface AccessPolicyExcludeAzure

interface AccessPolicyExcludeAzure

property id

id?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyExcludeGithub

interface AccessPolicyExcludeGithub

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Application.

interface AccessPolicyExcludeGsuite

interface AccessPolicyExcludeGsuite

property email

email?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyExcludeOkta

interface AccessPolicyExcludeOkta

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Application.

interface AccessPolicyExcludeSaml

interface AccessPolicyExcludeSaml

property attributeName

attributeName?: undefined | string;

property attributeValue

attributeValue?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyInclude

interface AccessPolicyInclude

property anyValidServiceToken

anyValidServiceToken?: undefined | false | true;

property azures

azures?: AccessPolicyIncludeAzure[];

property certificate

certificate?: undefined | false | true;

property commonName

commonName?: undefined | string;

property emailDomains

emailDomains?: string[];

property emails

emails?: string[];

property everyone

everyone?: undefined | false | true;

property githubs

githubs?: AccessPolicyIncludeGithub[];

property groups

groups?: string[];

property gsuites

gsuites?: AccessPolicyIncludeGsuite[];

property ips

ips?: string[];

property oktas

oktas?: AccessPolicyIncludeOkta[];

property samls

samls?: AccessPolicyIncludeSaml[];

property serviceTokens

serviceTokens?: string[];

interface AccessPolicyIncludeAzure

interface AccessPolicyIncludeAzure

property id

id?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyIncludeGithub

interface AccessPolicyIncludeGithub

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Application.

interface AccessPolicyIncludeGsuite

interface AccessPolicyIncludeGsuite

property email

email?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyIncludeOkta

interface AccessPolicyIncludeOkta

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Application.

interface AccessPolicyIncludeSaml

interface AccessPolicyIncludeSaml

property attributeName

attributeName?: undefined | string;

property attributeValue

attributeValue?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyRequire

interface AccessPolicyRequire

property anyValidServiceToken

anyValidServiceToken?: undefined | false | true;

property azures

azures?: AccessPolicyRequireAzure[];

property certificate

certificate?: undefined | false | true;

property commonName

commonName?: undefined | string;

property emailDomains

emailDomains?: string[];

property emails

emails?: string[];

property everyone

everyone?: undefined | false | true;

property githubs

githubs?: AccessPolicyRequireGithub[];

property groups

groups?: string[];

property gsuites

gsuites?: AccessPolicyRequireGsuite[];

property ips

ips?: string[];

property oktas

oktas?: AccessPolicyRequireOkta[];

property samls

samls?: AccessPolicyRequireSaml[];

property serviceTokens

serviceTokens?: string[];

interface AccessPolicyRequireAzure

interface AccessPolicyRequireAzure

property id

id?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyRequireGithub

interface AccessPolicyRequireGithub

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Application.

interface AccessPolicyRequireGsuite

interface AccessPolicyRequireGsuite

property email

email?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessPolicyRequireOkta

interface AccessPolicyRequireOkta

property identityProviderId

identityProviderId?: undefined | string;

property name

name?: undefined | string;

Friendly name of the Access Application.

interface AccessPolicyRequireSaml

interface AccessPolicyRequireSaml

property attributeName

attributeName?: undefined | string;

property attributeValue

attributeValue?: undefined | string;

property identityProviderId

identityProviderId?: undefined | string;

interface AccessRuleConfiguration

interface AccessRuleConfiguration

property target

target: string;

The request property to target. Allowed values: “ip”, “ip6”, “ipRange”, “asn”, “country”

property value

value: string;

The value to target. Depends on target’s type.

interface CustomSslCustomSslOptions

interface CustomSslCustomSslOptions

property bundleMethod

bundleMethod?: undefined | string;

Method of building intermediate certificate chain. A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it. Valid values are ubiquitous (default), optimal, force.

property certificate

certificate: string;

Certificate certificate and the intermediate(s)

property geoRestrictions

geoRestrictions?: undefined | string;

Specifies the region where your private key can be held locally. Valid values are us, eu, highestSecurity.

property privateKey

privateKey: string;

Certificate’s private key

property type

type?: undefined | string;

Whether to enable support for legacy clients which do not include SNI in the TLS handshake. Valid values are legacyCustom (default), sniCustom.

interface CustomSslCustomSslPriority

interface CustomSslCustomSslPriority

property id

id?: undefined | string;

property priority

priority?: undefined | number;

interface GetWafGroupsFilter

interface GetWafGroupsFilter

property mode

mode?: undefined | string;

property name

name?: undefined | string;

interface GetWafGroupsGroup

interface GetWafGroupsGroup

property description

description?: undefined | string;

property id

id?: undefined | string;

property mode

mode?: undefined | string;

property modifiedRulesCount

modifiedRulesCount?: undefined | number;

property name

name?: undefined | string;

property packageId

packageId?: undefined | string;

property rulesCount

rulesCount?: undefined | number;

interface GetWafPackagesFilter

interface GetWafPackagesFilter

property actionMode

actionMode?: undefined | string;

property detectionMode

detectionMode?: undefined | string;

property name

name?: undefined | string;

property sensitivity

sensitivity?: undefined | string;

interface GetWafPackagesPackage

interface GetWafPackagesPackage

property actionMode

actionMode?: undefined | string;

property description

description?: undefined | string;

property detectionMode

detectionMode?: undefined | string;

property id

id?: undefined | string;

property name

name?: undefined | string;

property sensitivity

sensitivity?: undefined | string;

interface GetWafRulesFilter

interface GetWafRulesFilter

property description

description?: undefined | string;

property groupId

groupId?: undefined | string;

property mode

mode?: undefined | string;

interface GetWafRulesRule

interface GetWafRulesRule

property allowedModes

allowedModes?: string[];

property description

description?: undefined | string;

property groupId

groupId?: undefined | string;

property groupName

groupName?: undefined | string;

property id

id?: undefined | string;

property mode

mode?: undefined | string;

property packageId

packageId?: undefined | string;

property priority

priority?: undefined | string;

interface GetZonesFilter

interface GetZonesFilter

property name

name?: undefined | string;

property paused

paused?: undefined | false | true;

property status

status?: undefined | string;

interface GetZonesZone

interface GetZonesZone

property id

id?: undefined | string;

property name

name?: undefined | string;

interface HealthcheckHeader

interface HealthcheckHeader

property header

header: string;

The header name.

property values

values: string[];

A list of string values for the header.

interface LoadBalancerMonitorHeader

interface LoadBalancerMonitorHeader

property header

header: string;

The header name.

property values

values: string[];

A list of string values for the header.

interface LoadBalancerPoolOrigin

interface LoadBalancerPoolOrigin

property address

address: string;

The IP address (IPv4 or IPv6) of the origin, or the publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare.

property enabled

enabled?: undefined | false | true;

Whether to enable (the default) this origin within the Pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.

property name

name: string;

A human-identifiable name for the origin.

property weight

weight?: undefined | number;

The weight (0.01 - 1.00) of this origin, relative to other origins in the pool. Equal values mean equal weighting. A weight of 0 means traffic will not be sent to this origin, but health is still checked. Default: 1.

interface LoadBalancerPopPool

interface LoadBalancerPopPool

property poolIds

poolIds: string[];

A list of pool IDs in failover priority to use for traffic reaching the given PoP.

property pop

pop: string;

A 3-letter code for the Point-of-Presence. Allowed values can be found in the list of datacenters on the status page. Multiple entries should not be specified with the same PoP.

interface LoadBalancerRegionPool

interface LoadBalancerRegionPool

property poolIds

poolIds: string[];

A list of pool IDs in failover priority to use for traffic reaching the given PoP.

property region

region: string;

A region code which must be in the list defined here. Multiple entries should not be specified with the same region.

interface PageRuleActions

interface PageRuleActions

property alwaysOnline

alwaysOnline?: undefined | string;

Whether this action is "on" or "off".

property alwaysUseHttps

alwaysUseHttps?: undefined | false | true;

Boolean of whether this action is enabled. Default: false.

property automaticHttpsRewrites

automaticHttpsRewrites?: undefined | string;

Whether this action is "on" or "off".

property browserCacheTtl

browserCacheTtl?: undefined | string;

The Time To Live for the browser cache. 0 means ‘Respect Existing Headers’

property browserCheck

browserCheck?: undefined | string;

Whether this action is "on" or "off".

property bypassCacheOnCookie

bypassCacheOnCookie?: undefined | string;

String value of cookie name to conditionally bypass cache the page.

property cacheByDeviceType

cacheByDeviceType?: undefined | string;

Whether this action is "on" or "off".

property cacheDeceptionArmor

cacheDeceptionArmor?: undefined | string;

Whether this action is "on" or "off".

property cacheKeyFields

cacheKeyFields?: outputs.PageRuleActionsCacheKeyFields;

Controls how Cloudflare creates Cache Keys used to identify files in cache. See below for full description.

property cacheLevel

cacheLevel?: undefined | string;

Whether to set the cache level to "bypass", "basic", "simplified", "aggressive", or "cacheEverything".

property cacheOnCookie

cacheOnCookie?: undefined | string;

String value of cookie name to conditionally cache the page.

property disableApps

disableApps?: undefined | false | true;

Boolean of whether this action is enabled. Default: false.

property disablePerformance

disablePerformance?: undefined | false | true;

Boolean of whether this action is enabled. Default: false.

property disableRailgun

disableRailgun?: undefined | false | true;

Boolean of whether this action is enabled. Default: false.

property disableSecurity

disableSecurity?: undefined | false | true;

Boolean of whether this action is enabled. Default: false.

property edgeCacheTtl

edgeCacheTtl?: undefined | number;

The Time To Live for the edge cache.

property emailObfuscation

emailObfuscation?: undefined | string;

Whether this action is "on" or "off".

property explicitCacheControl

explicitCacheControl?: undefined | string;

Whether origin Cache-Control action is "on" or "off".

property forwardingUrl

forwardingUrl?: outputs.PageRuleActionsForwardingUrl;

The URL to forward to, and with what status. See below.

property hostHeaderOverride

hostHeaderOverride?: undefined | string;

Value of the Host header to send.

property ipGeolocation

ipGeolocation?: undefined | string;

Whether this action is "on" or "off".

property minifies

minifies?: PageRuleActionsMinify[];

The configuration for HTML, CSS and JS minification. See below for full list of options.

property mirage

mirage?: undefined | string;

Whether this action is "on" or "off".

property opportunisticEncryption

opportunisticEncryption?: undefined | string;

Whether this action is "on" or "off".

property originErrorPagePassThru

originErrorPagePassThru?: undefined | string;

Whether this action is "on" or "off".

property polish

polish?: undefined | string;

Whether this action is "off", "lossless" or "lossy".

property resolveOverride

resolveOverride?: undefined | string;

Overridden origin server name.

property respectStrongEtag

respectStrongEtag?: undefined | string;

Whether this action is "on" or "off".

property responseBuffering

responseBuffering?: undefined | string;

Whether this action is "on" or "off".

property rocketLoader

rocketLoader?: undefined | string;

Whether to set the rocket loader to "on", "off".

property securityLevel

securityLevel?: undefined | string;

Whether to set the security level to "off", "essentiallyOff", "low", "medium", "high", or "underAttack".

property serverSideExclude

serverSideExclude?: undefined | string;

Whether this action is "on" or "off".

property sortQueryStringForCache

sortQueryStringForCache?: undefined | string;

Whether this action is "on" or "off".

property ssl

ssl?: undefined | string;

Whether to set the SSL mode to "off", "flexible", "full", "strict", or "originPull".

property trueClientIpHeader

trueClientIpHeader?: undefined | string;

Whether this action is "on" or "off".

property waf

waf?: undefined | string;

Whether this action is "on" or "off".

interface PageRuleActionsCacheKeyFields

interface PageRuleActionsCacheKeyFields
cookie: PageRuleActionsCacheKeyFieldsCookie;

Controls what cookies go into Cache Key:

property header

header: PageRuleActionsCacheKeyFieldsHeader;

Controls what HTTP headers go into Cache Key:

property host

host: PageRuleActionsCacheKeyFieldsHost;

Controls which Host header goes into Cache Key:

property queryString

queryString: PageRuleActionsCacheKeyFieldsQueryString;

Controls which URL query string parameters go into the Cache Key.

property user

user: PageRuleActionsCacheKeyFieldsUser;

Controls which end user-related features go into the Cache Key.

interface PageRuleActionsCacheKeyFieldsCookie

interface PageRuleActionsCacheKeyFieldsCookie

property checkPresences

checkPresences: string[];

Check for presence of specified HTTP headers, without including their actual values.

property includes

includes: string[];

Only use values of specified query string parameters in Cache Key.

interface PageRuleActionsCacheKeyFieldsHeader

interface PageRuleActionsCacheKeyFieldsHeader

property checkPresences

checkPresences: string[];

Check for presence of specified HTTP headers, without including their actual values.

property excludes

excludes: string[];

Exclude these query string parameters from Cache Key.

property includes

includes: string[];

Only use values of specified query string parameters in Cache Key.

interface PageRuleActionsCacheKeyFieldsHost

interface PageRuleActionsCacheKeyFieldsHost

property resolved

resolved: boolean;

false (default) - includes the Host header in the HTTP request sent to the origin; true - includes the Host header that was resolved to get the origin IP for the request (e.g. changed with Resolve Override Page Rule).

interface PageRuleActionsCacheKeyFieldsQueryString

interface PageRuleActionsCacheKeyFieldsQueryString

property excludes

excludes: string[];

Exclude these query string parameters from Cache Key.

property ignore

ignore: boolean;

false (default) - all query string parameters are used for Cache Key, unless explicitly excluded; true - all query string parameters are ignored; value is ignored if any of exclude or include is non-empty.

property includes

includes: string[];

Only use values of specified query string parameters in Cache Key.

interface PageRuleActionsCacheKeyFieldsUser

interface PageRuleActionsCacheKeyFieldsUser

property deviceType

deviceType: boolean;

true - classifies a request as “mobile”, “desktop”, or “tablet” based on the User Agent; defaults to false.

property geo

geo: boolean;

true - includes the client’s country, derived from the IP address; defaults to false.

property lang

lang: boolean;

true - includes the first language code contained in the Accept-Language header sent by the client; defaults to false.

interface PageRuleActionsForwardingUrl

interface PageRuleActionsForwardingUrl

property statusCode

statusCode: number;

The status code to use for the redirection.

property url

url: string;

The URL to which the page rule should forward.

interface PageRuleActionsMinify

interface PageRuleActionsMinify

property css

css: string;

Whether CSS should be minified. Valid values are "on" or "off".

property html

html: string;

Whether HTML should be minified. Valid values are "on" or "off".

property js

js: string;

Whether Javascript should be minified. Valid values are "on" or "off".

interface RateLimitAction

interface RateLimitAction

property mode

mode: string;

The type of action to perform. Allowable values are ‘simulate’, ‘ban’, ‘challenge’ and ‘js_challenge’.

property response

response?: outputs.RateLimitActionResponse;

Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

property timeout

timeout?: undefined | number;

The time in seconds as an integer to perform the mitigation action. This field is required if the mode is either simulate or ban. Must be the same or greater than the period (min: 1, max: 86400).

interface RateLimitActionResponse

interface RateLimitActionResponse

property body

body: string;

The body to return, the content here should conform to the content_type.

property contentType

contentType: string;

The content-type of the body, must be one of: ‘text/plain’, ‘text/xml’, ‘application/json’.

interface RateLimitCorrelate

interface RateLimitCorrelate

property by

by?: undefined | string;

If set to ‘nat’, NAT support will be enabled for rate limiting.

interface RateLimitMatch

interface RateLimitMatch

property request

request: RateLimitMatchRequest;

Matches HTTP requests (from the client to Cloudflare). See definition below.

property response

response: RateLimitMatchResponse;

Custom content-type and body to return, this overrides the custom error for the zone. This field is not required. Omission will result in default HTML error page. Definition below.

interface RateLimitMatchRequest

interface RateLimitMatchRequest

property methods

methods: string[];

HTTP Methods, can be a subset [‘POST’,‘PUT’] or all [’_ALL_’]. Default: [’_ALL_’].

property schemes

schemes: string[];

HTTP Schemes, can be one [‘HTTPS’], both [‘HTTP’,‘HTTPS’] or all [’_ALL_’]. Default: [’_ALL_’].

property urlPattern

urlPattern: string;

The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use * for all traffic to your zone. Default: ‘*‘.

interface RateLimitMatchResponse

interface RateLimitMatchResponse

property originTraffic

originTraffic: boolean;

Only count traffic that has come from your origin servers. If true, cached items that Cloudflare serve will not count towards rate limiting. Default: true.

property statuses

statuses: number[];

HTTP Status codes, can be one [403], many [401,403] or indicate all by not providing this value.

interface RecordData

interface RecordData

property algorithm

algorithm?: undefined | number;

property altitude

altitude?: undefined | number;

property certificate

certificate?: undefined | string;

property content

content?: undefined | string;

property digest

digest?: undefined | string;

property digestType

digestType?: undefined | number;

property fingerprint

fingerprint?: undefined | string;

property flags

flags?: undefined | string;

property keyTag

keyTag?: undefined | number;

property latDegrees

latDegrees?: undefined | number;

property latDirection

latDirection?: undefined | string;

property latMinutes

latMinutes?: undefined | number;

property latSeconds

latSeconds?: undefined | number;

property longDegrees

longDegrees?: undefined | number;

property longDirection

longDirection?: undefined | string;

property longMinutes

longMinutes?: undefined | number;

property longSeconds

longSeconds?: undefined | number;

property matchingType

matchingType?: undefined | number;

property name

name?: undefined | string;

The name of the record

property order

order?: undefined | number;

property port

port?: undefined | number;

property precisionHorz

precisionHorz?: undefined | number;

property precisionVert

precisionVert?: undefined | number;

property preference

preference?: undefined | number;

property priority

priority?: undefined | number;

The priority of the record

property proto

proto?: undefined | string;

property protocol

protocol?: undefined | number;

property publicKey

publicKey?: undefined | string;

property regex

regex?: undefined | string;

property replacement

replacement?: undefined | string;

property selector

selector?: undefined | number;

property service

service?: undefined | string;

property size

size?: undefined | number;

property target

target?: undefined | string;

property type

type?: undefined | number;

The type of the record

property usage

usage?: undefined | number;

property weight

weight?: undefined | number;

interface SpectrumApplicationDns

interface SpectrumApplicationDns

property name

name: string;

Fully qualified domain name of the origin e.g. origin-ssh.example.com.

property type

type: string;

The type of DNS record associated with the application. Valid values: CNAME.

interface SpectrumApplicationOriginDns

interface SpectrumApplicationOriginDns

property name

name: string;

Fully qualified domain name of the origin e.g. origin-ssh.example.com.

interface WorkerScriptKvNamespaceBinding

interface WorkerScriptKvNamespaceBinding

property name

name: string;

The name for the binding.

property namespaceId

namespaceId: string;

ID of KV namespace.

interface ZoneLockdownConfiguration

interface ZoneLockdownConfiguration

property target

target: string;

The request property to target. Allowed values: “ip”, “ipRange”

property value

value: string;

The value to target. Depends on target’s type. IP addresses should just be standard IPv4/IPv6 notation i.e. 198.51.100.4 or 2001:db8::/32 and IP ranges in CIDR format i.e. 198.51.0.0/16.

interface ZoneMeta

interface ZoneMeta

property phishingDetected

phishingDetected: boolean;

property wildcardProxiable

wildcardProxiable: boolean;

interface ZoneSettingsOverrideInitialSettings

interface ZoneSettingsOverrideInitialSettings

property alwaysOnline

alwaysOnline: string;

property alwaysUseHttps

alwaysUseHttps: string;

property automaticHttpsRewrites

automaticHttpsRewrites: string;

property brotli

brotli: string;

property browserCacheTtl

browserCacheTtl: number;

property browserCheck

browserCheck: string;

property cacheLevel

cacheLevel: string;

property challengeTtl

challengeTtl: number;

property cnameFlattening

cnameFlattening: string;

property developmentMode

developmentMode: string;

property emailObfuscation

emailObfuscation: string;

property h2Prioritization

h2Prioritization: string;

property hotlinkProtection

hotlinkProtection: string;

property http2

http2: string;

property http3

http3: string;

property imageResizing

imageResizing: string;

property ipGeolocation

ipGeolocation: string;

property ipv6

ipv6: string;

property maxUpload

maxUpload: number;

property minTlsVersion

minTlsVersion: string;

property minify

minify: ZoneSettingsOverrideInitialSettingsMinify;

property mirage

mirage: string;

property mobileRedirect

mobileRedirect: ZoneSettingsOverrideInitialSettingsMobileRedirect;

property opportunisticEncryption

opportunisticEncryption: string;

property opportunisticOnion

opportunisticOnion: string;

property originErrorPagePassThru

originErrorPagePassThru: string;

property polish

polish: string;

property prefetchPreload

prefetchPreload: string;

property privacyPass

privacyPass: string;

property pseudoIpv4

pseudoIpv4: string;

property responseBuffering

responseBuffering: string;

property rocketLoader

rocketLoader: string;

property securityHeader

securityHeader: ZoneSettingsOverrideInitialSettingsSecurityHeader;

property securityLevel

securityLevel: string;

property serverSideExclude

serverSideExclude: string;

property sortQueryStringForCache

sortQueryStringForCache: string;

property ssl

ssl: string;

property tls12Only

tls12Only: string;

property tls13

tls13: string;

property tlsClientAuth

tlsClientAuth: string;

property trueClientIpHeader

trueClientIpHeader: string;

property universalSsl

universalSsl: string;

property waf

waf: string;

property webp

webp: string;

. Note that the value specified will be ignored unless polish is turned on (i.e. is “lossless” or “lossy”)

property websockets

websockets: string;

property zeroRtt

zeroRtt: string;

interface ZoneSettingsOverrideInitialSettingsMinify

interface ZoneSettingsOverrideInitialSettingsMinify

property css

css: string;

“on”/“off”

property html

html: string;

“on”/“off”

property js

js: string;

“on”/“off”

interface ZoneSettingsOverrideInitialSettingsMobileRedirect

interface ZoneSettingsOverrideInitialSettingsMobileRedirect

property mobileSubdomain

mobileSubdomain: string;

String value

property status

status: string;

“on”/“off”

property stripUri

stripUri: boolean;

true/false

interface ZoneSettingsOverrideInitialSettingsSecurityHeader

interface ZoneSettingsOverrideInitialSettingsSecurityHeader

property enabled

enabled: boolean;

true/false

property includeSubdomains

includeSubdomains: boolean;

true/false

property maxAge

maxAge: number;

Integer

property nosniff

nosniff: boolean;

true/false

property preload

preload: boolean;

true/false

interface ZoneSettingsOverrideSettings

interface ZoneSettingsOverrideSettings

property alwaysOnline

alwaysOnline: string;

property alwaysUseHttps

alwaysUseHttps: string;

property automaticHttpsRewrites

automaticHttpsRewrites: string;

property brotli

brotli: string;

property browserCacheTtl

browserCacheTtl: number;

property browserCheck

browserCheck: string;

property cacheLevel

cacheLevel: string;

property challengeTtl

challengeTtl: number;

property cnameFlattening

cnameFlattening: string;

property developmentMode

developmentMode: string;

property emailObfuscation

emailObfuscation: string;

property h2Prioritization

h2Prioritization: string;

property hotlinkProtection

hotlinkProtection: string;

property http2

http2: string;

property http3

http3: string;

property imageResizing

imageResizing: string;

property ipGeolocation

ipGeolocation: string;

property ipv6

ipv6: string;

property maxUpload

maxUpload: number;

property minTlsVersion

minTlsVersion: string;

property minify

minify: ZoneSettingsOverrideSettingsMinify;

property mirage

mirage: string;

property mobileRedirect

mobileRedirect: ZoneSettingsOverrideSettingsMobileRedirect;

property opportunisticEncryption

opportunisticEncryption: string;

property opportunisticOnion

opportunisticOnion: string;

property originErrorPagePassThru

originErrorPagePassThru: string;

property polish

polish: string;

property prefetchPreload

prefetchPreload: string;

property privacyPass

privacyPass: string;

property pseudoIpv4

pseudoIpv4: string;

property responseBuffering

responseBuffering: string;

property rocketLoader

rocketLoader: string;

property securityHeader

securityHeader: ZoneSettingsOverrideSettingsSecurityHeader;

property securityLevel

securityLevel: string;

property serverSideExclude

serverSideExclude: string;

property sortQueryStringForCache

sortQueryStringForCache: string;

property ssl

ssl: string;

property tls12Only

tls12Only: string;

property tls13

tls13: string;

property tlsClientAuth

tlsClientAuth: string;

property trueClientIpHeader

trueClientIpHeader: string;

property universalSsl

universalSsl: string;

property waf

waf: string;

property webp

webp: string;

. Note that the value specified will be ignored unless polish is turned on (i.e. is “lossless” or “lossy”)

property websockets

websockets: string;

property zeroRtt

zeroRtt: string;

interface ZoneSettingsOverrideSettingsMinify

interface ZoneSettingsOverrideSettingsMinify

property css

css: string;

“on”/“off”

property html

html: string;

“on”/“off”

property js

js: string;

“on”/“off”

interface ZoneSettingsOverrideSettingsMobileRedirect

interface ZoneSettingsOverrideSettingsMobileRedirect

property mobileSubdomain

mobileSubdomain: string;

String value

property status

status: string;

“on”/“off”

property stripUri

stripUri: boolean;

true/false

interface ZoneSettingsOverrideSettingsSecurityHeader

interface ZoneSettingsOverrideSettingsSecurityHeader

property enabled

enabled: boolean;

true/false

property includeSubdomains

includeSubdomains: boolean;

true/false

property maxAge

maxAge: number;

Integer

property nosniff

nosniff: boolean;

true/false

property preload

preload: boolean;

true/false