cloudflare
Version:
The official TypeScript library for the Cloudflare API
701 lines • 41.5 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as SettingsAPI from 'cloudflare/resources/zones/settings/settings';
import * as AdvancedDDoSAPI from 'cloudflare/resources/zones/settings/advanced-ddos';
import * as AlwaysOnlineAPI from 'cloudflare/resources/zones/settings/always-online';
import * as AlwaysUseHTTPSAPI from 'cloudflare/resources/zones/settings/always-use-https';
import * as AutomaticHTTPSRewritesAPI from 'cloudflare/resources/zones/settings/automatic-https-rewrites';
import * as AutomaticPlatformOptimizationAPI from 'cloudflare/resources/zones/settings/automatic-platform-optimization';
import * as BrotliAPI from 'cloudflare/resources/zones/settings/brotli';
import * as BrowserCacheTTLAPI from 'cloudflare/resources/zones/settings/browser-cache-ttl';
import * as BrowserCheckAPI from 'cloudflare/resources/zones/settings/browser-check';
import * as CacheLevelAPI from 'cloudflare/resources/zones/settings/cache-level';
import * as ChallengeTTLAPI from 'cloudflare/resources/zones/settings/challenge-ttl';
import * as CiphersAPI from 'cloudflare/resources/zones/settings/ciphers';
import * as DevelopmentModeAPI from 'cloudflare/resources/zones/settings/development-mode';
import * as EarlyHintsAPI from 'cloudflare/resources/zones/settings/early-hints';
import * as EmailObfuscationAPI from 'cloudflare/resources/zones/settings/email-obfuscation';
import * as FontSettingsAPI from 'cloudflare/resources/zones/settings/font-settings';
import * as H2PrioritizationAPI from 'cloudflare/resources/zones/settings/h2-prioritization';
import * as HotlinkProtectionAPI from 'cloudflare/resources/zones/settings/hotlink-protection';
import * as HTTP2API from 'cloudflare/resources/zones/settings/http2';
import * as HTTP3API from 'cloudflare/resources/zones/settings/http3';
import * as ImageResizingAPI from 'cloudflare/resources/zones/settings/image-resizing';
import * as IPGeolocationAPI from 'cloudflare/resources/zones/settings/ip-geolocation';
import * as IPV6API from 'cloudflare/resources/zones/settings/ipv6';
import * as MinTLSVersionAPI from 'cloudflare/resources/zones/settings/min-tls-version';
import * as MinifyAPI from 'cloudflare/resources/zones/settings/minify';
import * as MirageAPI from 'cloudflare/resources/zones/settings/mirage';
import * as MobileRedirectAPI from 'cloudflare/resources/zones/settings/mobile-redirect';
import * as NELAPI from 'cloudflare/resources/zones/settings/nel';
import * as OpportunisticEncryptionAPI from 'cloudflare/resources/zones/settings/opportunistic-encryption';
import * as OpportunisticOnionAPI from 'cloudflare/resources/zones/settings/opportunistic-onion';
import * as OrangeToOrangeAPI from 'cloudflare/resources/zones/settings/orange-to-orange';
import * as OriginErrorPagePassThruAPI from 'cloudflare/resources/zones/settings/origin-error-page-pass-thru';
import * as OriginMaxHTTPVersionAPI from 'cloudflare/resources/zones/settings/origin-max-http-version';
import * as PolishAPI from 'cloudflare/resources/zones/settings/polish';
import * as PrefetchPreloadAPI from 'cloudflare/resources/zones/settings/prefetch-preload';
import * as ProxyReadTimeoutAPI from 'cloudflare/resources/zones/settings/proxy-read-timeout';
import * as PseudoIPV4API from 'cloudflare/resources/zones/settings/pseudo-ipv4';
import * as ResponseBufferingAPI from 'cloudflare/resources/zones/settings/response-buffering';
import * as RocketLoaderAPI from 'cloudflare/resources/zones/settings/rocket-loader';
import * as SecurityHeadersAPI from 'cloudflare/resources/zones/settings/security-headers';
import * as SecurityLevelAPI from 'cloudflare/resources/zones/settings/security-level';
import * as ServerSideExcludesAPI from 'cloudflare/resources/zones/settings/server-side-excludes';
import * as SortQueryStringForCacheAPI from 'cloudflare/resources/zones/settings/sort-query-string-for-cache';
import * as SSLAPI from 'cloudflare/resources/zones/settings/ssl';
import * as SSLRecommenderAPI from 'cloudflare/resources/zones/settings/ssl-recommender';
import * as TLS1_3API from 'cloudflare/resources/zones/settings/tls-1-3';
import * as TLSClientAuthAPI from 'cloudflare/resources/zones/settings/tls-client-auth';
import * as TrueClientIPHeaderAPI from 'cloudflare/resources/zones/settings/true-client-ip-header';
import * as WAFAPI from 'cloudflare/resources/zones/settings/waf';
import * as WebPAPI from 'cloudflare/resources/zones/settings/webp';
import * as WebsocketAPI from 'cloudflare/resources/zones/settings/websocket';
import * as ZeroRTTAPI from 'cloudflare/resources/zones/settings/zero-rtt';
export declare class Settings extends APIResource {
zeroRTT: ZeroRTTAPI.ZeroRTT;
advancedDDoS: AdvancedDDoSAPI.AdvancedDDoS;
alwaysOnline: AlwaysOnlineAPI.AlwaysOnline;
alwaysUseHTTPS: AlwaysUseHTTPSAPI.AlwaysUseHTTPS;
automaticHTTPSRewrites: AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewrites;
automaticPlatformOptimization: AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimization;
brotli: BrotliAPI.Brotli;
browserCacheTTL: BrowserCacheTTLAPI.BrowserCacheTTL;
browserCheck: BrowserCheckAPI.BrowserCheck;
cacheLevel: CacheLevelAPI.CacheLevel;
challengeTTL: ChallengeTTLAPI.ChallengeTTL;
ciphers: CiphersAPI.Ciphers;
developmentMode: DevelopmentModeAPI.DevelopmentMode;
earlyHints: EarlyHintsAPI.EarlyHints;
emailObfuscation: EmailObfuscationAPI.EmailObfuscation;
h2Prioritization: H2PrioritizationAPI.H2Prioritization;
hotlinkProtection: HotlinkProtectionAPI.HotlinkProtection;
http2: HTTP2API.HTTP2;
http3: HTTP3API.HTTP3;
imageResizing: ImageResizingAPI.ImageResizing;
ipGeolocation: IPGeolocationAPI.IPGeolocation;
ipv6: IPV6API.IPV6;
minTLSVersion: MinTLSVersionAPI.MinTLSVersion;
minify: MinifyAPI.Minify;
mirage: MirageAPI.Mirage;
mobileRedirect: MobileRedirectAPI.MobileRedirect;
nel: NELAPI.NEL;
opportunisticEncryption: OpportunisticEncryptionAPI.OpportunisticEncryption;
opportunisticOnion: OpportunisticOnionAPI.OpportunisticOnion;
orangeToOrange: OrangeToOrangeAPI.OrangeToOrange;
originErrorPagePassThru: OriginErrorPagePassThruAPI.OriginErrorPagePassThru;
originMaxHTTPVersion: OriginMaxHTTPVersionAPI.OriginMaxHTTPVersion;
polish: PolishAPI.Polish;
prefetchPreload: PrefetchPreloadAPI.PrefetchPreload;
proxyReadTimeout: ProxyReadTimeoutAPI.ProxyReadTimeout;
pseudoIPV4: PseudoIPV4API.PseudoIPV4;
responseBuffering: ResponseBufferingAPI.ResponseBuffering;
rocketLoader: RocketLoaderAPI.RocketLoader;
securityHeaders: SecurityHeadersAPI.SecurityHeaders;
securityLevel: SecurityLevelAPI.SecurityLevel;
serverSideExcludes: ServerSideExcludesAPI.ServerSideExcludes;
sortQueryStringForCache: SortQueryStringForCacheAPI.SortQueryStringForCache;
ssl: SSLAPI.SSL;
sslRecommender: SSLRecommenderAPI.SSLRecommender;
tls1_3: TLS1_3API.TLS1_3;
tlsClientAuth: TLSClientAuthAPI.TLSClientAuth;
trueClientIPHeader: TrueClientIPHeaderAPI.TrueClientIPHeader;
waf: WAFAPI.WAF;
WebP: WebPAPI.WebP;
websocket: WebsocketAPI.Websocket;
fontSettings: FontSettingsAPI.FontSettings;
/**
* Edit settings for a zone.
*/
edit(params: SettingEditParams, options?: Core.RequestOptions): Core.APIPromise<SettingEditResponse>;
/**
* Available settings for your user in relation to a zone.
*/
get(params: SettingGetParams, options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse>;
}
export type SettingEditResponse = Array<ZeroRTTAPI.ZoneSetting0rtt | AdvancedDDoSAPI.ZoneSettingAdvancedDDoS | AlwaysOnlineAPI.ZoneSettingAlwaysOnline | AlwaysUseHTTPSAPI.ZoneSettingAlwaysUseHTTPS | AutomaticHTTPSRewritesAPI.ZoneSettingAutomaticHTTPSRewrites | BrotliAPI.ZoneSettingBrotli | BrowserCacheTTLAPI.ZoneSettingBrowserCacheTTL | BrowserCheckAPI.ZoneSettingBrowserCheck | CacheLevelAPI.ZoneSettingCacheLevel | ChallengeTTLAPI.ZoneSettingChallengeTTL | CiphersAPI.ZoneSettingCiphers | SettingEditResponse.ZonesCNAMEFlattening | DevelopmentModeAPI.ZoneSettingDevelopmentMode | EarlyHintsAPI.ZoneSettingEarlyHints | SettingEditResponse.ZonesEdgeCacheTTL | EmailObfuscationAPI.ZoneSettingEmailObfuscation | H2PrioritizationAPI.ZoneSettingH2Prioritization | HotlinkProtectionAPI.ZoneSettingHotlinkProtection | HTTP2API.ZoneSettingHTTP2 | HTTP3API.ZoneSettingHTTP3 | ImageResizingAPI.ZoneSettingImageResizing | IPGeolocationAPI.ZoneSettingIPGeolocation | IPV6API.ZoneSettingIPV6 | SettingEditResponse.ZonesMaxUpload | MinTLSVersionAPI.ZoneSettingMinTLSVersion | MinifyAPI.ZoneSettingMinify | MirageAPI.ZoneSettingMirage | MobileRedirectAPI.ZoneSettingMobileRedirect | NELAPI.ZoneSettingNEL | OpportunisticEncryptionAPI.ZoneSettingOpportunisticEncryption | OpportunisticOnionAPI.ZoneSettingOpportunisticOnion | OrangeToOrangeAPI.ZoneSettingOrangeToOrange | OriginErrorPagePassThruAPI.ZoneSettingOriginErrorPagePassThru | PolishAPI.ZoneSettingPolish | PrefetchPreloadAPI.ZoneSettingPrefetchPreload | ProxyReadTimeoutAPI.ZoneSettingProxyReadTimeout | PseudoIPV4API.ZoneSettingPseudoIPV4 | ResponseBufferingAPI.ZoneSettingBuffering | RocketLoaderAPI.ZoneSettingRocketLoader | SettingEditResponse.ZonesSchemasAutomaticPlatformOptimization | SecurityHeadersAPI.ZoneSettingSecurityHeader | SecurityLevelAPI.ZoneSettingSecurityLevel | ServerSideExcludesAPI.ZoneSettingServerSideExclude | SettingEditResponse.ZonesSha1Support | SortQueryStringForCacheAPI.ZoneSettingSortQueryStringForCache | SSLAPI.ZoneSettingSSL | SSLRecommenderAPI.ZoneSettingSSLRecommender | SettingEditResponse.ZonesTLS1_2Only | TLS1_3API.ZoneSettingTLS1_3 | TLSClientAuthAPI.ZoneSettingTLSClientAuth | TrueClientIPHeaderAPI.ZoneSettingTrueClientIPHeader | WAFAPI.ZoneSettingWAF | WebPAPI.ZoneSettingWebP | WebsocketAPI.ZoneSettingWebsockets>;
export declare namespace SettingEditResponse {
/**
* Whether or not cname flattening is on.
*/
interface ZonesCNAMEFlattening {
/**
* How to flatten the cname destination.
*/
id: 'cname_flattening';
/**
* Current value of the zone setting.
*/
value: 'flatten_at_root' | 'flatten_all';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Time (in seconds) that a resource will be ensured to remain on Cloudflare's
* cache servers.
*/
interface ZonesEdgeCacheTTL {
/**
* ID of the zone setting.
*/
id: 'edge_cache_ttl';
/**
* Current value of the zone setting.
*/
value: 30 | 60 | 300 | 1200 | 1800 | 3600 | 7200 | 10800 | 14400 | 18000 | 28800 | 43200 | 57600 | 72000 | 86400 | 172800 | 259200 | 345600 | 432000 | 518400 | 604800;
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Maximum size of an allowable upload.
*/
interface ZonesMaxUpload {
/**
* identifier of the zone setting.
*/
id: 'max_upload';
/**
* Current value of the zone setting.
*/
value: 100 | 200 | 500;
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)
* serves your WordPress site from Cloudflare's edge network and caches third-party
* fonts.
*/
interface ZonesSchemasAutomaticPlatformOptimization {
/**
* ID of the zone setting.
*/
id: 'automatic_platform_optimization';
/**
* Current value of the zone setting.
*/
value: AutomaticPlatformOptimizationAPI.ZoneSettingAutomaticPlatformOptimization;
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Allow SHA1 support.
*/
interface ZonesSha1Support {
/**
* Zone setting identifier.
*/
id: 'sha1_support';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Only allows TLS1.2.
*/
interface ZonesTLS1_2Only {
/**
* Zone setting identifier.
*/
id: 'tls_1_2_only';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
}
export type SettingGetResponse = Array<ZeroRTTAPI.ZoneSetting0rtt | AdvancedDDoSAPI.ZoneSettingAdvancedDDoS | AlwaysOnlineAPI.ZoneSettingAlwaysOnline | AlwaysUseHTTPSAPI.ZoneSettingAlwaysUseHTTPS | AutomaticHTTPSRewritesAPI.ZoneSettingAutomaticHTTPSRewrites | BrotliAPI.ZoneSettingBrotli | BrowserCacheTTLAPI.ZoneSettingBrowserCacheTTL | BrowserCheckAPI.ZoneSettingBrowserCheck | CacheLevelAPI.ZoneSettingCacheLevel | ChallengeTTLAPI.ZoneSettingChallengeTTL | CiphersAPI.ZoneSettingCiphers | SettingGetResponse.ZonesCNAMEFlattening | DevelopmentModeAPI.ZoneSettingDevelopmentMode | EarlyHintsAPI.ZoneSettingEarlyHints | SettingGetResponse.ZonesEdgeCacheTTL | EmailObfuscationAPI.ZoneSettingEmailObfuscation | H2PrioritizationAPI.ZoneSettingH2Prioritization | HotlinkProtectionAPI.ZoneSettingHotlinkProtection | HTTP2API.ZoneSettingHTTP2 | HTTP3API.ZoneSettingHTTP3 | ImageResizingAPI.ZoneSettingImageResizing | IPGeolocationAPI.ZoneSettingIPGeolocation | IPV6API.ZoneSettingIPV6 | SettingGetResponse.ZonesMaxUpload | MinTLSVersionAPI.ZoneSettingMinTLSVersion | MinifyAPI.ZoneSettingMinify | MirageAPI.ZoneSettingMirage | MobileRedirectAPI.ZoneSettingMobileRedirect | NELAPI.ZoneSettingNEL | OpportunisticEncryptionAPI.ZoneSettingOpportunisticEncryption | OpportunisticOnionAPI.ZoneSettingOpportunisticOnion | OrangeToOrangeAPI.ZoneSettingOrangeToOrange | OriginErrorPagePassThruAPI.ZoneSettingOriginErrorPagePassThru | PolishAPI.ZoneSettingPolish | PrefetchPreloadAPI.ZoneSettingPrefetchPreload | ProxyReadTimeoutAPI.ZoneSettingProxyReadTimeout | PseudoIPV4API.ZoneSettingPseudoIPV4 | ResponseBufferingAPI.ZoneSettingBuffering | RocketLoaderAPI.ZoneSettingRocketLoader | SettingGetResponse.ZonesSchemasAutomaticPlatformOptimization | SecurityHeadersAPI.ZoneSettingSecurityHeader | SecurityLevelAPI.ZoneSettingSecurityLevel | ServerSideExcludesAPI.ZoneSettingServerSideExclude | SettingGetResponse.ZonesSha1Support | SortQueryStringForCacheAPI.ZoneSettingSortQueryStringForCache | SSLAPI.ZoneSettingSSL | SSLRecommenderAPI.ZoneSettingSSLRecommender | SettingGetResponse.ZonesTLS1_2Only | TLS1_3API.ZoneSettingTLS1_3 | TLSClientAuthAPI.ZoneSettingTLSClientAuth | TrueClientIPHeaderAPI.ZoneSettingTrueClientIPHeader | WAFAPI.ZoneSettingWAF | WebPAPI.ZoneSettingWebP | WebsocketAPI.ZoneSettingWebsockets>;
export declare namespace SettingGetResponse {
/**
* Whether or not cname flattening is on.
*/
interface ZonesCNAMEFlattening {
/**
* How to flatten the cname destination.
*/
id: 'cname_flattening';
/**
* Current value of the zone setting.
*/
value: 'flatten_at_root' | 'flatten_all';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Time (in seconds) that a resource will be ensured to remain on Cloudflare's
* cache servers.
*/
interface ZonesEdgeCacheTTL {
/**
* ID of the zone setting.
*/
id: 'edge_cache_ttl';
/**
* Current value of the zone setting.
*/
value: 30 | 60 | 300 | 1200 | 1800 | 3600 | 7200 | 10800 | 14400 | 18000 | 28800 | 43200 | 57600 | 72000 | 86400 | 172800 | 259200 | 345600 | 432000 | 518400 | 604800;
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Maximum size of an allowable upload.
*/
interface ZonesMaxUpload {
/**
* identifier of the zone setting.
*/
id: 'max_upload';
/**
* Current value of the zone setting.
*/
value: 100 | 200 | 500;
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)
* serves your WordPress site from Cloudflare's edge network and caches third-party
* fonts.
*/
interface ZonesSchemasAutomaticPlatformOptimization {
/**
* ID of the zone setting.
*/
id: 'automatic_platform_optimization';
/**
* Current value of the zone setting.
*/
value: AutomaticPlatformOptimizationAPI.ZoneSettingAutomaticPlatformOptimization;
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Allow SHA1 support.
*/
interface ZonesSha1Support {
/**
* Zone setting identifier.
*/
id: 'sha1_support';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
/**
* Only allows TLS1.2.
*/
interface ZonesTLS1_2Only {
/**
* Zone setting identifier.
*/
id: 'tls_1_2_only';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
/**
* Whether or not this setting can be modified for this zone (based on your
* Cloudflare plan level).
*/
editable?: true | false;
/**
* last time this setting was modified.
*/
modified_on?: string | null;
}
}
export interface SettingEditParams {
/**
* Path param: Identifier
*/
zone_id: string;
/**
* Body param: One or more zone setting objects. Must contain an ID and a value.
*/
items: Array<ZeroRTTAPI.ZoneSetting0rtt | AdvancedDDoSAPI.ZoneSettingAdvancedDDoS | AlwaysOnlineAPI.ZoneSettingAlwaysOnline | AlwaysUseHTTPSAPI.ZoneSettingAlwaysUseHTTPS | AutomaticHTTPSRewritesAPI.ZoneSettingAutomaticHTTPSRewrites | BrotliAPI.ZoneSettingBrotli | BrowserCacheTTLAPI.ZoneSettingBrowserCacheTTL | BrowserCheckAPI.ZoneSettingBrowserCheck | CacheLevelAPI.ZoneSettingCacheLevel | ChallengeTTLAPI.ZoneSettingChallengeTTL | CiphersAPI.ZoneSettingCiphers | SettingEditParams.ZonesCNAMEFlattening | DevelopmentModeAPI.ZoneSettingDevelopmentMode | EarlyHintsAPI.ZoneSettingEarlyHints | SettingEditParams.ZonesEdgeCacheTTL | EmailObfuscationAPI.ZoneSettingEmailObfuscation | H2PrioritizationAPI.ZoneSettingH2Prioritization | HotlinkProtectionAPI.ZoneSettingHotlinkProtection | HTTP2API.ZoneSettingHTTP2 | HTTP3API.ZoneSettingHTTP3 | ImageResizingAPI.ZoneSettingImageResizing | IPGeolocationAPI.ZoneSettingIPGeolocation | IPV6API.ZoneSettingIPV6 | SettingEditParams.ZonesMaxUpload | MinTLSVersionAPI.ZoneSettingMinTLSVersion | MinifyAPI.ZoneSettingMinify | MirageAPI.ZoneSettingMirage | MobileRedirectAPI.ZoneSettingMobileRedirect | NELAPI.ZoneSettingNEL | OpportunisticEncryptionAPI.ZoneSettingOpportunisticEncryption | OpportunisticOnionAPI.ZoneSettingOpportunisticOnion | OrangeToOrangeAPI.ZoneSettingOrangeToOrange | OriginErrorPagePassThruAPI.ZoneSettingOriginErrorPagePassThru | PolishAPI.ZoneSettingPolish | PrefetchPreloadAPI.ZoneSettingPrefetchPreload | ProxyReadTimeoutAPI.ZoneSettingProxyReadTimeout | PseudoIPV4API.ZoneSettingPseudoIPV4 | ResponseBufferingAPI.ZoneSettingBuffering | RocketLoaderAPI.ZoneSettingRocketLoader | SettingEditParams.ZonesSchemasAutomaticPlatformOptimization | SecurityHeadersAPI.ZoneSettingSecurityHeader | SecurityLevelAPI.ZoneSettingSecurityLevel | ServerSideExcludesAPI.ZoneSettingServerSideExclude | SettingEditParams.ZonesSha1Support | SortQueryStringForCacheAPI.ZoneSettingSortQueryStringForCache | SSLAPI.ZoneSettingSSL | SSLRecommenderAPI.ZoneSettingSSLRecommender | SettingEditParams.ZonesTLS1_2Only | TLS1_3API.ZoneSettingTLS1_3 | TLSClientAuthAPI.ZoneSettingTLSClientAuth | TrueClientIPHeaderAPI.ZoneSettingTrueClientIPHeader | WAFAPI.ZoneSettingWAF | WebPAPI.ZoneSettingWebP | WebsocketAPI.ZoneSettingWebsockets>;
}
export declare namespace SettingEditParams {
/**
* Whether or not cname flattening is on.
*/
interface ZonesCNAMEFlattening {
/**
* How to flatten the cname destination.
*/
id: 'cname_flattening';
/**
* Current value of the zone setting.
*/
value: 'flatten_at_root' | 'flatten_all';
}
/**
* Time (in seconds) that a resource will be ensured to remain on Cloudflare's
* cache servers.
*/
interface ZonesEdgeCacheTTL {
/**
* ID of the zone setting.
*/
id: 'edge_cache_ttl';
/**
* Current value of the zone setting.
*/
value: 30 | 60 | 300 | 1200 | 1800 | 3600 | 7200 | 10800 | 14400 | 18000 | 28800 | 43200 | 57600 | 72000 | 86400 | 172800 | 259200 | 345600 | 432000 | 518400 | 604800;
}
/**
* Maximum size of an allowable upload.
*/
interface ZonesMaxUpload {
/**
* identifier of the zone setting.
*/
id: 'max_upload';
/**
* Current value of the zone setting.
*/
value: 100 | 200 | 500;
}
/**
* [Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)
* serves your WordPress site from Cloudflare's edge network and caches third-party
* fonts.
*/
interface ZonesSchemasAutomaticPlatformOptimization {
/**
* ID of the zone setting.
*/
id: 'automatic_platform_optimization';
/**
* Current value of the zone setting.
*/
value: AutomaticPlatformOptimizationAPI.ZoneSettingAutomaticPlatformOptimization;
}
/**
* Allow SHA1 support.
*/
interface ZonesSha1Support {
/**
* Zone setting identifier.
*/
id: 'sha1_support';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
}
/**
* Only allows TLS1.2.
*/
interface ZonesTLS1_2Only {
/**
* Zone setting identifier.
*/
id: 'tls_1_2_only';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
}
}
export interface SettingGetParams {
/**
* Identifier
*/
zone_id: string;
}
export declare namespace Settings {
export import SettingEditResponse = SettingsAPI.SettingEditResponse;
export import SettingGetResponse = SettingsAPI.SettingGetResponse;
export import SettingEditParams = SettingsAPI.SettingEditParams;
export import SettingGetParams = SettingsAPI.SettingGetParams;
export import ZeroRTT = ZeroRTTAPI.ZeroRTT;
export import ZoneSetting0rtt = ZeroRTTAPI.ZoneSetting0rtt;
export import ZeroRTTEditParams = ZeroRTTAPI.ZeroRTTEditParams;
export import ZeroRTTGetParams = ZeroRTTAPI.ZeroRTTGetParams;
export import AdvancedDDoS = AdvancedDDoSAPI.AdvancedDDoS;
export import ZoneSettingAdvancedDDoS = AdvancedDDoSAPI.ZoneSettingAdvancedDDoS;
export import AdvancedDDoSGetParams = AdvancedDDoSAPI.AdvancedDDoSGetParams;
export import AlwaysOnline = AlwaysOnlineAPI.AlwaysOnline;
export import ZoneSettingAlwaysOnline = AlwaysOnlineAPI.ZoneSettingAlwaysOnline;
export import AlwaysOnlineEditParams = AlwaysOnlineAPI.AlwaysOnlineEditParams;
export import AlwaysOnlineGetParams = AlwaysOnlineAPI.AlwaysOnlineGetParams;
export import AlwaysUseHTTPS = AlwaysUseHTTPSAPI.AlwaysUseHTTPS;
export import ZoneSettingAlwaysUseHTTPS = AlwaysUseHTTPSAPI.ZoneSettingAlwaysUseHTTPS;
export import AlwaysUseHTTPSEditParams = AlwaysUseHTTPSAPI.AlwaysUseHTTPSEditParams;
export import AlwaysUseHTTPSGetParams = AlwaysUseHTTPSAPI.AlwaysUseHTTPSGetParams;
export import AutomaticHTTPSRewrites = AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewrites;
export import ZoneSettingAutomaticHTTPSRewrites = AutomaticHTTPSRewritesAPI.ZoneSettingAutomaticHTTPSRewrites;
export import AutomaticHTTPSRewriteEditParams = AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewriteEditParams;
export import AutomaticHTTPSRewriteGetParams = AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewriteGetParams;
export import AutomaticPlatformOptimization = AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimization;
export import ZoneSettingAutomaticPlatformOptimization = AutomaticPlatformOptimizationAPI.ZoneSettingAutomaticPlatformOptimization;
export import AutomaticPlatformOptimizationEditParams = AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimizationEditParams;
export import AutomaticPlatformOptimizationGetParams = AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimizationGetParams;
export import Brotli = BrotliAPI.Brotli;
export import ZoneSettingBrotli = BrotliAPI.ZoneSettingBrotli;
export import BrotliEditParams = BrotliAPI.BrotliEditParams;
export import BrotliGetParams = BrotliAPI.BrotliGetParams;
export import BrowserCacheTTL = BrowserCacheTTLAPI.BrowserCacheTTL;
export import ZoneSettingBrowserCacheTTL = BrowserCacheTTLAPI.ZoneSettingBrowserCacheTTL;
export import BrowserCacheTTLEditParams = BrowserCacheTTLAPI.BrowserCacheTTLEditParams;
export import BrowserCacheTTLGetParams = BrowserCacheTTLAPI.BrowserCacheTTLGetParams;
export import BrowserCheck = BrowserCheckAPI.BrowserCheck;
export import ZoneSettingBrowserCheck = BrowserCheckAPI.ZoneSettingBrowserCheck;
export import BrowserCheckEditParams = BrowserCheckAPI.BrowserCheckEditParams;
export import BrowserCheckGetParams = BrowserCheckAPI.BrowserCheckGetParams;
export import CacheLevel = CacheLevelAPI.CacheLevel;
export import ZoneSettingCacheLevel = CacheLevelAPI.ZoneSettingCacheLevel;
export import CacheLevelEditParams = CacheLevelAPI.CacheLevelEditParams;
export import CacheLevelGetParams = CacheLevelAPI.CacheLevelGetParams;
export import ChallengeTTL = ChallengeTTLAPI.ChallengeTTL;
export import ZoneSettingChallengeTTL = ChallengeTTLAPI.ZoneSettingChallengeTTL;
export import ChallengeTTLEditParams = ChallengeTTLAPI.ChallengeTTLEditParams;
export import ChallengeTTLGetParams = ChallengeTTLAPI.ChallengeTTLGetParams;
export import Ciphers = CiphersAPI.Ciphers;
export import ZoneSettingCiphers = CiphersAPI.ZoneSettingCiphers;
export import CipherEditParams = CiphersAPI.CipherEditParams;
export import CipherGetParams = CiphersAPI.CipherGetParams;
export import DevelopmentMode = DevelopmentModeAPI.DevelopmentMode;
export import ZoneSettingDevelopmentMode = DevelopmentModeAPI.ZoneSettingDevelopmentMode;
export import DevelopmentModeEditParams = DevelopmentModeAPI.DevelopmentModeEditParams;
export import DevelopmentModeGetParams = DevelopmentModeAPI.DevelopmentModeGetParams;
export import EarlyHints = EarlyHintsAPI.EarlyHints;
export import ZoneSettingEarlyHints = EarlyHintsAPI.ZoneSettingEarlyHints;
export import EarlyHintEditParams = EarlyHintsAPI.EarlyHintEditParams;
export import EarlyHintGetParams = EarlyHintsAPI.EarlyHintGetParams;
export import EmailObfuscation = EmailObfuscationAPI.EmailObfuscation;
export import ZoneSettingEmailObfuscation = EmailObfuscationAPI.ZoneSettingEmailObfuscation;
export import EmailObfuscationEditParams = EmailObfuscationAPI.EmailObfuscationEditParams;
export import EmailObfuscationGetParams = EmailObfuscationAPI.EmailObfuscationGetParams;
export import H2Prioritization = H2PrioritizationAPI.H2Prioritization;
export import ZoneSettingH2Prioritization = H2PrioritizationAPI.ZoneSettingH2Prioritization;
export import H2PrioritizationEditParams = H2PrioritizationAPI.H2PrioritizationEditParams;
export import H2PrioritizationGetParams = H2PrioritizationAPI.H2PrioritizationGetParams;
export import HotlinkProtection = HotlinkProtectionAPI.HotlinkProtection;
export import ZoneSettingHotlinkProtection = HotlinkProtectionAPI.ZoneSettingHotlinkProtection;
export import HotlinkProtectionEditParams = HotlinkProtectionAPI.HotlinkProtectionEditParams;
export import HotlinkProtectionGetParams = HotlinkProtectionAPI.HotlinkProtectionGetParams;
export import HTTP2 = HTTP2API.HTTP2;
export import ZoneSettingHTTP2 = HTTP2API.ZoneSettingHTTP2;
export import HTTP2EditParams = HTTP2API.HTTP2EditParams;
export import HTTP2GetParams = HTTP2API.HTTP2GetParams;
export import HTTP3 = HTTP3API.HTTP3;
export import ZoneSettingHTTP3 = HTTP3API.ZoneSettingHTTP3;
export import HTTP3EditParams = HTTP3API.HTTP3EditParams;
export import HTTP3GetParams = HTTP3API.HTTP3GetParams;
export import ImageResizing = ImageResizingAPI.ImageResizing;
export import ZoneSettingImageResizing = ImageResizingAPI.ZoneSettingImageResizing;
export import ImageResizingEditParams = ImageResizingAPI.ImageResizingEditParams;
export import ImageResizingGetParams = ImageResizingAPI.ImageResizingGetParams;
export import IPGeolocation = IPGeolocationAPI.IPGeolocation;
export import ZoneSettingIPGeolocation = IPGeolocationAPI.ZoneSettingIPGeolocation;
export import IPGeolocationEditParams = IPGeolocationAPI.IPGeolocationEditParams;
export import IPGeolocationGetParams = IPGeolocationAPI.IPGeolocationGetParams;
export import IPV6 = IPV6API.IPV6;
export import ZoneSettingIPV6 = IPV6API.ZoneSettingIPV6;
export import IPV6EditParams = IPV6API.IPV6EditParams;
export import IPV6GetParams = IPV6API.IPV6GetParams;
export import MinTLSVersion = MinTLSVersionAPI.MinTLSVersion;
export import ZoneSettingMinTLSVersion = MinTLSVersionAPI.ZoneSettingMinTLSVersion;
export import MinTLSVersionEditParams = MinTLSVersionAPI.MinTLSVersionEditParams;
export import MinTLSVersionGetParams = MinTLSVersionAPI.MinTLSVersionGetParams;
export import Minify = MinifyAPI.Minify;
export import ZoneSettingMinify = MinifyAPI.ZoneSettingMinify;
export import MinifyEditParams = MinifyAPI.MinifyEditParams;
export import MinifyGetParams = MinifyAPI.MinifyGetParams;
export import Mirage = MirageAPI.Mirage;
export import ZoneSettingMirage = MirageAPI.ZoneSettingMirage;
export import MirageEditParams = MirageAPI.MirageEditParams;
export import MirageGetParams = MirageAPI.MirageGetParams;
export import MobileRedirect = MobileRedirectAPI.MobileRedirect;
export import ZoneSettingMobileRedirect = MobileRedirectAPI.ZoneSettingMobileRedirect;
export import MobileRedirectEditParams = MobileRedirectAPI.MobileRedirectEditParams;
export import MobileRedirectGetParams = MobileRedirectAPI.MobileRedirectGetParams;
export import NEL = NELAPI.NEL;
export import ZoneSettingNEL = NELAPI.ZoneSettingNEL;
export import NELEditParams = NELAPI.NELEditParams;
export import NELGetParams = NELAPI.NELGetParams;
export import OpportunisticEncryption = OpportunisticEncryptionAPI.OpportunisticEncryption;
export import ZoneSettingOpportunisticEncryption = OpportunisticEncryptionAPI.ZoneSettingOpportunisticEncryption;
export import OpportunisticEncryptionEditParams = OpportunisticEncryptionAPI.OpportunisticEncryptionEditParams;
export import OpportunisticEncryptionGetParams = OpportunisticEncryptionAPI.OpportunisticEncryptionGetParams;
export import OpportunisticOnion = OpportunisticOnionAPI.OpportunisticOnion;
export import ZoneSettingOpportunisticOnion = OpportunisticOnionAPI.ZoneSettingOpportunisticOnion;
export import OpportunisticOnionEditParams = OpportunisticOnionAPI.OpportunisticOnionEditParams;
export import OpportunisticOnionGetParams = OpportunisticOnionAPI.OpportunisticOnionGetParams;
export import OrangeToOrange = OrangeToOrangeAPI.OrangeToOrange;
export import ZoneSettingOrangeToOrange = OrangeToOrangeAPI.ZoneSettingOrangeToOrange;
export import OrangeToOrangeEditParams = OrangeToOrangeAPI.OrangeToOrangeEditParams;
export import OrangeToOrangeGetParams = OrangeToOrangeAPI.OrangeToOrangeGetParams;
export import OriginErrorPagePassThru = OriginErrorPagePassThruAPI.OriginErrorPagePassThru;
export import ZoneSettingOriginErrorPagePassThru = OriginErrorPagePassThruAPI.ZoneSettingOriginErrorPagePassThru;
export import OriginErrorPagePassThruEditParams = OriginErrorPagePassThruAPI.OriginErrorPagePassThruEditParams;
export import OriginErrorPagePassThruGetParams = OriginErrorPagePassThruAPI.OriginErrorPagePassThruGetParams;
export import OriginMaxHTTPVersion = OriginMaxHTTPVersionAPI.OriginMaxHTTPVersion;
export import OriginMaxHTTPVersionEditResponse = OriginMaxHTTPVersionAPI.OriginMaxHTTPVersionEditResponse;
export import OriginMaxHTTPVersionGetResponse = OriginMaxHTTPVersionAPI.OriginMaxHTTPVersionGetResponse;
export import OriginMaxHTTPVersionEditParams = OriginMaxHTTPVersionAPI.OriginMaxHTTPVersionEditParams;
export import OriginMaxHTTPVersionGetParams = OriginMaxHTTPVersionAPI.OriginMaxHTTPVersionGetParams;
export import Polish = PolishAPI.Polish;
export import ZoneSettingPolish = PolishAPI.ZoneSettingPolish;
export import PolishEditParams = PolishAPI.PolishEditParams;
export import PolishGetParams = PolishAPI.PolishGetParams;
export import PrefetchPreload = PrefetchPreloadAPI.PrefetchPreload;
export import ZoneSettingPrefetchPreload = PrefetchPreloadAPI.ZoneSettingPrefetchPreload;
export import PrefetchPreloadEditParams = PrefetchPreloadAPI.PrefetchPreloadEditParams;
export import PrefetchPreloadGetParams = PrefetchPreloadAPI.PrefetchPreloadGetParams;
export import ProxyReadTimeout = ProxyReadTimeoutAPI.ProxyReadTimeout;
export import ZoneSettingProxyReadTimeout = ProxyReadTimeoutAPI.ZoneSettingProxyReadTimeout;
export import ProxyReadTimeoutEditParams = ProxyReadTimeoutAPI.ProxyReadTimeoutEditParams;
export import ProxyReadTimeoutGetParams = ProxyReadTimeoutAPI.ProxyReadTimeoutGetParams;
export import PseudoIPV4 = PseudoIPV4API.PseudoIPV4;
export import ZoneSettingPseudoIPV4 = PseudoIPV4API.ZoneSettingPseudoIPV4;
export import PseudoIPV4EditParams = PseudoIPV4API.PseudoIPV4EditParams;
export import PseudoIPV4GetParams = PseudoIPV4API.PseudoIPV4GetParams;
export import ResponseBuffering = ResponseBufferingAPI.ResponseBuffering;
export import ZoneSettingBuffering = ResponseBufferingAPI.ZoneSettingBuffering;
export import ResponseBufferingEditParams = ResponseBufferingAPI.ResponseBufferingEditParams;
export import ResponseBufferingGetParams = ResponseBufferingAPI.ResponseBufferingGetParams;
export import RocketLoader = RocketLoaderAPI.RocketLoader;
export import ZoneSettingRocketLoader = RocketLoaderAPI.ZoneSettingRocketLoader;
export import RocketLoaderEditParams = RocketLoaderAPI.RocketLoaderEditParams;
export import RocketLoaderGetParams = RocketLoaderAPI.RocketLoaderGetParams;
export import SecurityHeaders = SecurityHeadersAPI.SecurityHeaders;
export import ZoneSettingSecurityHeader = SecurityHeadersAPI.ZoneSettingSecurityHeader;
export import SecurityHeaderEditParams = SecurityHeadersAPI.SecurityHeaderEditParams;
export import SecurityHeaderGetParams = SecurityHeadersAPI.SecurityHeaderGetParams;
export import SecurityLevel = SecurityLevelAPI.SecurityLevel;
export import ZoneSettingSecurityLevel = SecurityLevelAPI.ZoneSettingSecurityLevel;
export import SecurityLevelEditParams = SecurityLevelAPI.SecurityLevelEditParams;
export import SecurityLevelGetParams = SecurityLevelAPI.SecurityLevelGetParams;
export import ServerSideExcludes = ServerSideExcludesAPI.ServerSideExcludes;
export import ZoneSettingServerSideExclude = ServerSideExcludesAPI.ZoneSettingServerSideExclude;
export import ServerSideExcludeEditParams = ServerSideExcludesAPI.ServerSideExcludeEditParams;
export import ServerSideExcludeGetParams = ServerSideExcludesAPI.ServerSideExcludeGetParams;
export import SortQueryStringForCache = SortQueryStringForCacheAPI.SortQueryStringForCache;
export import ZoneSettingSortQueryStringForCache = SortQueryStringForCacheAPI.ZoneSettingSortQueryStringForCache;
export import SortQueryStringForCacheEditParams = SortQueryStringForCacheAPI.SortQueryStringForCacheEditParams;
export import SortQueryStringForCacheGetParams = SortQueryStringForCacheAPI.SortQueryStringForCacheGetParams;
export import SSL = SSLAPI.SSL;
export import ZoneSettingSSL = SSLAPI.ZoneSettingSSL;
export import SSLEditParams = SSLAPI.SSLEditParams;
export import SSLGetParams = SSLAPI.SSLGetParams;
export import SSLRecommender = SSLRecommenderAPI.SSLRecommender;
export import ZoneSettingSSLRecommender = SSLRecommenderAPI.ZoneSettingSSLRecommender;
export import SSLRecommenderEditParams = SSLRecommenderAPI.SSLRecommenderEditParams;
export import SSLRecommenderGetParams = SSLRecommenderAPI.SSLRecommenderGetParams;
export import TLS1_3 = TLS1_3API.TLS1_3;
export import ZoneSettingTLS1_3 = TLS1_3API.ZoneSettingTLS1_3;
export import TLS1_3EditParams = TLS1_3API.TLS1_3EditParams;
export import TLS1_3GetParams = TLS1_3API.TLS1_3GetParams;
export import TLSClientAuth = TLSClientAuthAPI.TLSClientAuth;
export import ZoneSettingTLSClientAuth = TLSClientAuthAPI.ZoneSettingTLSClientAuth;
export import TLSClientAuthEditParams = TLSClientAuthAPI.TLSClientAuthEditParams;
export import TLSClientAuthGetParams = TLSClientAuthAPI.TLSClientAuthGetParams;
export import TrueClientIPHeader = TrueClientIPHeaderAPI.TrueClientIPHeader;
export import ZoneSettingTrueClientIPHeader = TrueClientIPHeaderAPI.ZoneSettingTrueClientIPHeader;
export import TrueClientIPHeaderEditParams = TrueClientIPHeaderAPI.TrueClientIPHeaderEditParams;
export import TrueClientIPHeaderGetParams = TrueClientIPHeaderAPI.TrueClientIPHeaderGetParams;
export import WAF = WAFAPI.WAF;
export import ZoneSettingWAF = WAFAPI.ZoneSettingWAF;
export import WAFEditParams = WAFAPI.WAFEditParams;
export import WAFGetParams = WAFAPI.WAFGetParams;
export import WebP = WebPAPI.WebP;
export import ZoneSettingWebP = WebPAPI.ZoneSettingWebP;
export import WebPEditParams = WebPAPI.WebPEditParams;
export import WebPGetParams = WebPAPI.WebPGetParams;
export import Websocket = WebsocketAPI.Websocket;
export import ZoneSettingWebsockets = WebsocketAPI.ZoneSettingWebsockets;
export import WebsocketEditParams = WebsocketAPI.WebsocketEditParams;
export import WebsocketGetParams = WebsocketAPI.WebsocketGetParams;
export import FontSettings = FontSettingsAPI.FontSettings;
export import ZoneSettingFonts = FontSettingsAPI.ZoneSettingFonts;
export import FontSettingEditParams = FontSettingsAPI.FontSettingEditParams;
export import FontSettingGetParams = FontSettingsAPI.FontSettingGetParams;
}
//# sourceMappingURL=settings.d.ts.map