cloudflare
Version:
The official TypeScript library for the Cloudflare API
1,036 lines (965 loc) • 42.1 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import * as Core from "../../../core";
import { APIResource } from "../../../resource";
import * as SettingsAPI from "./settings";
import * as AdvancedDDoSAPI from "./advanced-ddos";
import * as AlwaysOnlineAPI from "./always-online";
import * as AlwaysUseHTTPSAPI from "./always-use-https";
import * as AutomaticHTTPSRewritesAPI from "./automatic-https-rewrites";
import * as AutomaticPlatformOptimizationAPI from "./automatic-platform-optimization";
import * as BrotliAPI from "./brotli";
import * as BrowserCacheTTLAPI from "./browser-cache-ttl";
import * as BrowserCheckAPI from "./browser-check";
import * as CacheLevelAPI from "./cache-level";
import * as ChallengeTTLAPI from "./challenge-ttl";
import * as CiphersAPI from "./ciphers";
import * as DevelopmentModeAPI from "./development-mode";
import * as EarlyHintsAPI from "./early-hints";
import * as EmailObfuscationAPI from "./email-obfuscation";
import * as FontSettingsAPI from "./font-settings";
import * as H2PrioritizationAPI from "./h2-prioritization";
import * as HotlinkProtectionAPI from "./hotlink-protection";
import * as HTTP2API from "./http2";
import * as HTTP3API from "./http3";
import * as ImageResizingAPI from "./image-resizing";
import * as IPGeolocationAPI from "./ip-geolocation";
import * as IPV6API from "./ipv6";
import * as MinTLSVersionAPI from "./min-tls-version";
import * as MinifyAPI from "./minify";
import * as MirageAPI from "./mirage";
import * as MobileRedirectAPI from "./mobile-redirect";
import * as NELAPI from "./nel";
import * as OpportunisticEncryptionAPI from "./opportunistic-encryption";
import * as OpportunisticOnionAPI from "./opportunistic-onion";
import * as OrangeToOrangeAPI from "./orange-to-orange";
import * as OriginErrorPagePassThruAPI from "./origin-error-page-pass-thru";
import * as OriginMaxHTTPVersionAPI from "./origin-max-http-version";
import * as PolishAPI from "./polish";
import * as PrefetchPreloadAPI from "./prefetch-preload";
import * as ProxyReadTimeoutAPI from "./proxy-read-timeout";
import * as PseudoIPV4API from "./pseudo-ipv4";
import * as ResponseBufferingAPI from "./response-buffering";
import * as RocketLoaderAPI from "./rocket-loader";
import * as SecurityHeadersAPI from "./security-headers";
import * as SecurityLevelAPI from "./security-level";
import * as ServerSideExcludesAPI from "./server-side-excludes";
import * as SortQueryStringForCacheAPI from "./sort-query-string-for-cache";
import * as SSLAPI from "./ssl";
import * as SSLRecommenderAPI from "./ssl-recommender";
import * as TLS1_3API from "./tls-1-3";
import * as TLSClientAuthAPI from "./tls-client-auth";
import * as TrueClientIPHeaderAPI from "./true-client-ip-header";
import * as WAFAPI from "./waf";
import * as WebPAPI from "./webp";
import * as WebsocketAPI from "./websocket";
import * as ZeroRTTAPI from "./zero-rtt";
export class Settings extends APIResource {
zeroRTT: ZeroRTTAPI.ZeroRTT = new ZeroRTTAPI.ZeroRTT(this._client);
advancedDDoS: AdvancedDDoSAPI.AdvancedDDoS = new AdvancedDDoSAPI.AdvancedDDoS(this._client);
alwaysOnline: AlwaysOnlineAPI.AlwaysOnline = new AlwaysOnlineAPI.AlwaysOnline(this._client);
alwaysUseHTTPS: AlwaysUseHTTPSAPI.AlwaysUseHTTPS = new AlwaysUseHTTPSAPI.AlwaysUseHTTPS(this._client);
automaticHTTPSRewrites: AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewrites =
new AutomaticHTTPSRewritesAPI.AutomaticHTTPSRewrites(this._client);
automaticPlatformOptimization: AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimization =
new AutomaticPlatformOptimizationAPI.AutomaticPlatformOptimization(this._client);
brotli: BrotliAPI.Brotli = new BrotliAPI.Brotli(this._client);
browserCacheTTL: BrowserCacheTTLAPI.BrowserCacheTTL = new BrowserCacheTTLAPI.BrowserCacheTTL(this._client);
browserCheck: BrowserCheckAPI.BrowserCheck = new BrowserCheckAPI.BrowserCheck(this._client);
cacheLevel: CacheLevelAPI.CacheLevel = new CacheLevelAPI.CacheLevel(this._client);
challengeTTL: ChallengeTTLAPI.ChallengeTTL = new ChallengeTTLAPI.ChallengeTTL(this._client);
ciphers: CiphersAPI.Ciphers = new CiphersAPI.Ciphers(this._client);
developmentMode: DevelopmentModeAPI.DevelopmentMode = new DevelopmentModeAPI.DevelopmentMode(this._client);
earlyHints: EarlyHintsAPI.EarlyHints = new EarlyHintsAPI.EarlyHints(this._client);
emailObfuscation: EmailObfuscationAPI.EmailObfuscation = new EmailObfuscationAPI.EmailObfuscation(
this._client,
);
h2Prioritization: H2PrioritizationAPI.H2Prioritization = new H2PrioritizationAPI.H2Prioritization(
this._client,
);
hotlinkProtection: HotlinkProtectionAPI.HotlinkProtection = new HotlinkProtectionAPI.HotlinkProtection(
this._client,
);
http2: HTTP2API.HTTP2 = new HTTP2API.HTTP2(this._client);
http3: HTTP3API.HTTP3 = new HTTP3API.HTTP3(this._client);
imageResizing: ImageResizingAPI.ImageResizing = new ImageResizingAPI.ImageResizing(this._client);
ipGeolocation: IPGeolocationAPI.IPGeolocation = new IPGeolocationAPI.IPGeolocation(this._client);
ipv6: IPV6API.IPV6 = new IPV6API.IPV6(this._client);
minTLSVersion: MinTLSVersionAPI.MinTLSVersion = new MinTLSVersionAPI.MinTLSVersion(this._client);
minify: MinifyAPI.Minify = new MinifyAPI.Minify(this._client);
mirage: MirageAPI.Mirage = new MirageAPI.Mirage(this._client);
mobileRedirect: MobileRedirectAPI.MobileRedirect = new MobileRedirectAPI.MobileRedirect(this._client);
nel: NELAPI.NEL = new NELAPI.NEL(this._client);
opportunisticEncryption: OpportunisticEncryptionAPI.OpportunisticEncryption =
new OpportunisticEncryptionAPI.OpportunisticEncryption(this._client);
opportunisticOnion: OpportunisticOnionAPI.OpportunisticOnion = new OpportunisticOnionAPI.OpportunisticOnion(
this._client,
);
orangeToOrange: OrangeToOrangeAPI.OrangeToOrange = new OrangeToOrangeAPI.OrangeToOrange(this._client);
originErrorPagePassThru: OriginErrorPagePassThruAPI.OriginErrorPagePassThru =
new OriginErrorPagePassThruAPI.OriginErrorPagePassThru(this._client);
originMaxHTTPVersion: OriginMaxHTTPVersionAPI.OriginMaxHTTPVersion =
new OriginMaxHTTPVersionAPI.OriginMaxHTTPVersion(this._client);
polish: PolishAPI.Polish = new PolishAPI.Polish(this._client);
prefetchPreload: PrefetchPreloadAPI.PrefetchPreload = new PrefetchPreloadAPI.PrefetchPreload(this._client);
proxyReadTimeout: ProxyReadTimeoutAPI.ProxyReadTimeout = new ProxyReadTimeoutAPI.ProxyReadTimeout(
this._client,
);
pseudoIPV4: PseudoIPV4API.PseudoIPV4 = new PseudoIPV4API.PseudoIPV4(this._client);
responseBuffering: ResponseBufferingAPI.ResponseBuffering = new ResponseBufferingAPI.ResponseBuffering(
this._client,
);
rocketLoader: RocketLoaderAPI.RocketLoader = new RocketLoaderAPI.RocketLoader(this._client);
securityHeaders: SecurityHeadersAPI.SecurityHeaders = new SecurityHeadersAPI.SecurityHeaders(this._client);
securityLevel: SecurityLevelAPI.SecurityLevel = new SecurityLevelAPI.SecurityLevel(this._client);
serverSideExcludes: ServerSideExcludesAPI.ServerSideExcludes = new ServerSideExcludesAPI.ServerSideExcludes(
this._client,
);
sortQueryStringForCache: SortQueryStringForCacheAPI.SortQueryStringForCache =
new SortQueryStringForCacheAPI.SortQueryStringForCache(this._client);
ssl: SSLAPI.SSL = new SSLAPI.SSL(this._client);
sslRecommender: SSLRecommenderAPI.SSLRecommender = new SSLRecommenderAPI.SSLRecommender(this._client);
tls1_3: TLS1_3API.TLS1_3 = new TLS1_3API.TLS1_3(this._client);
tlsClientAuth: TLSClientAuthAPI.TLSClientAuth = new TLSClientAuthAPI.TLSClientAuth(this._client);
trueClientIPHeader: TrueClientIPHeaderAPI.TrueClientIPHeader = new TrueClientIPHeaderAPI.TrueClientIPHeader(
this._client,
);
waf: WAFAPI.WAF = new WAFAPI.WAF(this._client);
WebP: WebPAPI.WebP = new WebPAPI.WebP(this._client);
websocket: WebsocketAPI.Websocket = new WebsocketAPI.Websocket(this._client);
fontSettings: FontSettingsAPI.FontSettings = new FontSettingsAPI.FontSettings(this._client);
/**
* Edit settings for a zone.
*/
edit(params: SettingEditParams, options?: Core.RequestOptions): Core.APIPromise<SettingEditResponse> {
const { zone_id, ...body } = params;
return (
this._client.patch(`/zones/${zone_id}/settings`, { body, ...options }) as Core.APIPromise<{
result: SettingEditResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Available settings for your user in relation to a zone.
*/
get(params: SettingGetParams, options?: Core.RequestOptions): Core.APIPromise<SettingGetResponse> {
const { zone_id } = params;
return (
this._client.get(`/zones/${zone_id}/settings`, options) as Core.APIPromise<{
result: SettingGetResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
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 namespace SettingEditResponse {
/**
* Whether or not cname flattening is on.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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 namespace SettingGetResponse {
/**
* Whether or not cname flattening is on.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export 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 namespace SettingEditParams {
/**
* Whether or not cname flattening is on.
*/
export 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.
*/
export 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.
*/
export 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.
*/
export interface ZonesSchemasAutomaticPlatformOptimization {
/**
* ID of the zone setting.
*/
id: 'automatic_platform_optimization';
/**
* Current value of the zone setting.
*/
value: AutomaticPlatformOptimizationAPI.ZoneSettingAutomaticPlatformOptimization;
}
/**
* Allow SHA1 support.
*/
export interface ZonesSha1Support {
/**
* Zone setting identifier.
*/
id: 'sha1_support';
/**
* Current value of the zone setting.
*/
value: 'off' | 'on';
}
/**
* Only allows TLS1.2.
*/
export 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 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;
}