Search + K

Command Palette

Search for a command to run...

Sign In

Edit zone setting

PATCH /zones/{zone_id}/settings/{setting_id}
Copy endpoint
https://api.cloudflare.com/client/v4

Updates a single zone setting by the identifier

Parameters

path Path Parameters

Name Type
zone_id required
type ZonesIdentifier = string
setting_id required
type ZonesSettingName = string

Request Body

application/json required
type ZonesZoneSettingsSingleRequest = { enabled?: ZonesSslRecommenderEnabled

ssl-recommender enrollment setting.

type ZonesSslRecommenderEnabled = boolean
; }
| { value?: ZonesSettingValue
type ZonesSettingValue = Zones0rttValue | ZonesAdvancedDdosValue | ZonesCacheRulesAegisValue | ZonesAlwaysOnlineValue | ZonesAlwaysUseHttpsValue | ZonesAutomaticHttpsRewritesValue | ZonesBrotliValue | ZonesBrowserCacheTtlValue | ZonesBrowserCheckValue | ZonesCacheLevelValue | ZonesChallengeTtlValue | ZonesChinaNetworkEnabledValue | ZonesCiphersValue | ZonesCnameFlatteningValue | ZonesDevelopmentModeValue | ZonesEarlyHintsValue | ZonesEdgeCacheTtlValue | ZonesEmailObfuscationValue | ZonesH2PrioritizationValue | ZonesHotlinkProtectionValue | ZonesHttp2Value | ZonesHttp3Value | ZonesImageResizingValue | ZonesIpGeolocationValue | ZonesIpv6Value | ZonesMaxUploadValue | ZonesMinTlsVersionValue | ZonesMirageValue | ZonesNelValue | ZonesOpportunisticEncryptionValue | ZonesOpportunisticOnionValue | ZonesOrangeToOrangeValue | ZonesOriginErrorPagePassThruValue | ZonesCacheRulesOriginH2MaxStreamsValue | ZonesCacheRulesOriginMaxHttpVersionValue | ZonesPolishValue | ZonesPrefetchPreloadValue | ZonesPrivacyPassValue | ZonesProxyReadTimeoutValue | ZonesPseudoIpv4Value | ZonesReplaceInsecureJsValue | ZonesResponseBufferingValue | ZonesRocketLoaderValue | ZonesAutomaticPlatformOptimization | ZonesSecurityHeaderValue | ZonesSecurityLevelValue | ZonesServerSideExcludeValue | ZonesSha1SupportValue | ZonesSortQueryStringForCacheValue | ZonesSslValue | ZonesTls12OnlyValue | ZonesTls13Value | ZonesTlsClientAuthValue | ZonesTrueClientIpHeaderValue | ZonesWafValue | ZonesWebpValue | ZonesWebsocketsValue
; }

Responses

200 application/json

Edit zone setting response

interface ZonesSettingsApiComponentsSchemasApiResponseCommon {
errors: ZonesMessages
type ZonesMessages = { code: number;message: string; }[]
;
messages: ZonesMessages
type ZonesMessages = { code: number;message: string; }[]
;
success: boolean;
}
& { result?: ZonesSetting
type ZonesSetting = Zones0rtt & {} | ZonesAdvancedDdos & {} | ZonesCacheRulesAegis & {} | ZonesAlwaysOnline & {} | ZonesSchemasAlwaysUseHttps & {} | ZonesSchemasAutomaticHttpsRewrites & {} | ZonesBrotli & {} | ZonesSchemasBrowserCacheTtl & {} | ZonesSchemasBrowserCheck & {} | ZonesSchemasCacheLevel & {} | ZonesChallengeTtl & {} | ZonesChinaNetworkEnabled & {} | ZonesCiphers & {} | ZonesCnameFlattening & {} | ZonesDevelopmentMode & {} | ZonesEarlyHints & {} | ZonesSchemasEdgeCacheTtl & {} | ZonesSchemasEmailObfuscation & {} | ZonesH2Prioritization & {} | ZonesHotlinkProtection & {} | ZonesHttp2 & {} | ZonesHttp3 & {} | ZonesImageResizing & {} | ZonesSchemasIpGeolocation & {} | ZonesIpv6 & {} | ZonesMaxUpload & {} | ZonesMinTlsVersion & {} | ZonesSchemasMirage & {} | ZonesNel & {} | ZonesSchemasOpportunisticEncryption & {} | ZonesOpportunisticOnion & {} | ZonesOrangeToOrange & {} | ZonesSchemasOriginErrorPagePassThru & {} | ZonesCacheRulesOriginH2MaxStreams & {} | ZonesCacheRulesOriginMaxHttpVersion & {} | ZonesSchemasPolish & {} | ZonesPrefetchPreload & {} | ZonesPrivacyPass & {} | ZonesProxyReadTimeout & {} | ZonesPseudoIpv4 & {} | ZonesReplaceInsecureJs & {} | ZonesSchemasResponseBuffering & {} | ZonesSchemasRocketLoader & {} | ZonesSchemasAutomaticPlatformOptimization & {} | ZonesSecurityHeader & {} | ZonesSchemasSecurityLevel & {} | ZonesServerSideExclude & {} | ZonesSha1Support & {} | ZonesSchemasSortQueryStringForCache & {} | ZonesSchemasSsl & {} | ZonesSslRecommender & {} | ZonesTls12Only & {} | ZonesTls13 & {} | ZonesTlsClientAuth & {} | ZonesTransformations & {} | ZonesTransformationsAllowedOrigins & {} | ZonesSchemasTrueClientIpHeader & {} | ZonesSchemasWaf & {} | ZonesWebp & {} | ZonesWebsockets & {}
; }

Client Errors

4XX application/json

Edit zone settings info response failure

interface ZonesComponentsSchemasApiResponseCommonFailure {
errors: ZonesMessages
type ZonesMessages = { code: number;message: string; }[]
;
messages: ZonesMessages
type ZonesMessages = { code: number;message: string; }[]
;
result: {} | null;
success: boolean;
}