Skip to main content
POST
/
pullzone
/
{id}
Update Pull Zone
curl --request POST \
  --url https://api.bunny.net/pullzone/{id} \
  --header 'AccessKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "PreloadingScreenShowOnFirstVisit": true,
  "OriginUrl": "<string>",
  "AllowedReferrers": [
    "<string>"
  ],
  "BlockedReferrers": [
    "<string>"
  ],
  "BlockNoneReferrer": true,
  "BlockedIps": [
    "<string>"
  ],
  "EnableGeoZoneUS": true,
  "EnableGeoZoneEU": true,
  "EnableGeoZoneASIA": true,
  "EnableGeoZoneSA": true,
  "EnableGeoZoneAF": true,
  "BlockRootPathAccess": true,
  "BlockPostRequests": true,
  "EnableQueryStringOrdering": true,
  "EnableWebpVary": true,
  "EnableAvifVary": true,
  "EnableMobileVary": true,
  "EnableCountryCodeVary": true,
  "EnableCountryStateCodeVary": true,
  "EnableHostnameVary": true,
  "EnableCacheSlice": true,
  "ZoneSecurityEnabled": true,
  "ZoneSecurityIncludeHashRemoteIP": true,
  "IgnoreQueryStrings": true,
  "MonthlyBandwidthLimit": 123,
  "AccessControlOriginHeaderExtensions": [
    "<string>"
  ],
  "EnableAccessControlOriginHeader": true,
  "DisableCookies": true,
  "BudgetRedirectedCountries": [
    "<string>"
  ],
  "BlockedCountries": [
    "<string>"
  ],
  "CacheControlMaxAgeOverride": 123,
  "CacheControlPublicMaxAgeOverride": 123,
  "CacheControlBrowserMaxAgeOverride": 123,
  "AddHostHeader": true,
  "AddCanonicalHeader": true,
  "EnableLogging": true,
  "LoggingIPAnonymizationEnabled": true,
  "PermaCacheStorageZoneId": 123,
  "PermaCacheType": "Automatic",
  "AWSSigningEnabled": true,
  "AWSSigningKey": "<string>",
  "AWSSigningRegionName": "<string>",
  "AWSSigningSecret": "<string>",
  "EnableOriginShield": true,
  "OriginShieldZoneCode": "<string>",
  "EnableTLS1": true,
  "EnableTLS1_1": true,
  "CacheErrorResponses": true,
  "VerifyOriginSSL": true,
  "LogForwardingEnabled": true,
  "LogForwardingHostname": "<string>",
  "LogForwardingPort": 123,
  "LogForwardingToken": "<string>",
  "LogForwardingProtocol": "UDP",
  "LoggingSaveToStorage": true,
  "LoggingStorageZoneId": 123,
  "FollowRedirects": true,
  "ConnectionLimitPerIPCount": 123,
  "RequestLimit": 123,
  "LimitRateAfter": 123,
  "LimitRatePerSecond": 123,
  "BurstSize": 123,
  "ErrorPageEnableCustomCode": true,
  "ErrorPageCustomCode": "<string>",
  "ErrorPageEnableStatuspageWidget": true,
  "ErrorPageStatuspageCode": "<string>",
  "ErrorPageWhitelabel": true,
  "OptimizerEnabled": true,
  "OptimizerTunnelEnabled": true,
  "OptimizerDesktopMaxWidth": 2500,
  "OptimizerMobileMaxWidth": 2500,
  "OptimizerImageQuality": 50,
  "OptimizerMobileImageQuality": 50,
  "OptimizerEnableWebP": true,
  "OptimizerPrerenderHtml": true,
  "OptimizerEnableManipulationEngine": true,
  "OptimizerMinifyCSS": true,
  "OptimizerMinifyJavaScript": true,
  "OptimizerWatermarkEnabled": true,
  "OptimizerWatermarkUrl": "<string>",
  "OptimizerWatermarkPosition": {},
  "OptimizerWatermarkOffset": 123,
  "OptimizerWatermarkMinImageSize": 123,
  "OptimizerAutomaticOptimizationEnabled": true,
  "OptimizerClasses": [
    {
      "Name": "<string>",
      "Properties": {}
    }
  ],
  "OptimizerForceClasses": true,
  "OptimizerStaticHtmlWordPressPath": "<string>",
  "OptimizerStaticHtmlWordPressBypassCookie": "<string>",
  "Type": "Premium",
  "OriginRetries": 123,
  "OriginConnectTimeout": 123,
  "OriginResponseTimeout": 123,
  "UseStaleWhileUpdating": true,
  "UseStaleWhileOffline": true,
  "OriginRetry5XXResponses": true,
  "OriginRetryConnectionTimeout": true,
  "OriginRetryResponseTimeout": true,
  "OriginRetryDelay": 123,
  "DnsOriginPort": 123,
  "DnsOriginScheme": "<string>",
  "QueryStringVaryParameters": [
    "<string>"
  ],
  "OriginShieldEnableConcurrencyLimit": true,
  "OriginShieldMaxConcurrentRequests": 5000,
  "EnableCookieVary": true,
  "CookieVaryParameters": [
    "<string>"
  ],
  "EnableSafeHop": true,
  "OriginShieldQueueMaxWaitTime": 123,
  "OriginShieldMaxQueuedRequests": 15000,
  "UseBackgroundUpdate": true,
  "EnableAutoSSL": true,
  "LogAnonymizationType": "OneDigit",
  "StorageZoneId": 123,
  "EdgeScriptId": 123,
  "MiddlewareScriptId": 123,
  "EdgeScriptExecutionPhase": "Cache",
  "OriginType": "OriginUrl",
  "MagicContainersAppId": "<string>",
  "MagicContainersEndpointId": "<string>",
  "LogFormat": "Plain",
  "LogForwardingFormat": "Plain",
  "ShieldDDosProtectionType": "DetectOnly",
  "ShieldDDosProtectionEnabled": true,
  "OriginHostHeader": "<string>",
  "EnableSmartCache": true,
  "EnableRequestCoalescing": true,
  "RequestCoalescingTimeout": 123,
  "DisableLetsEncrypt": true,
  "EnableBunnyImageAi": true,
  "BunnyAiImageBlueprints": [
    {
      "Name": "<string>",
      "Properties": {}
    }
  ],
  "PreloadingScreenEnabled": true,
  "PreloadingScreenCode": "<string>",
  "PreloadingScreenLogoUrl": "<string>",
  "PreloadingScreenTheme": "Light",
  "PreloadingScreenCodeEnabled": true,
  "PreloadingScreenDelay": 5000,
  "RoutingFilters": [
    "<string>"
  ],
  "StickySessionType": "Off",
  "StickySessionCookieName": "<string>",
  "StickySessionClientHeaders": "<string>",
  "OptimizerEnableUpscaling": true,
  "EnableWebSockets": true,
  "MaxWebSocketConnections": 123
}
'
{
  "Id": 123,
  "Enabled": true,
  "Suspended": true,
  "StorageZoneId": 123,
  "EdgeScriptId": 123,
  "EnableGeoZoneUS": true,
  "EnableGeoZoneEU": true,
  "EnableGeoZoneASIA": true,
  "EnableGeoZoneSA": true,
  "EnableGeoZoneAF": true,
  "ZoneSecurityEnabled": true,
  "ZoneSecurityIncludeHashRemoteIP": true,
  "IgnoreQueryStrings": true,
  "MonthlyBandwidthLimit": 123,
  "MonthlyBandwidthUsed": 123,
  "MonthlyCharges": 123,
  "AddHostHeader": true,
  "EnableAccessControlOriginHeader": true,
  "DisableCookies": true,
  "EnableOriginShield": true,
  "CacheControlMaxAgeOverride": 123,
  "CacheControlPublicMaxAgeOverride": 123,
  "BurstSize": 123,
  "RequestLimit": 123,
  "BlockRootPathAccess": true,
  "BlockPostRequests": true,
  "LimitRatePerSecond": 123,
  "LimitRateAfter": 123,
  "ConnectionLimitPerIPCount": 123,
  "PriceOverride": 123,
  "OptimizerPricing": 123,
  "AddCanonicalHeader": true,
  "EnableLogging": true,
  "EnableCacheSlice": true,
  "EnableSmartCache": true,
  "EnableWebPVary": true,
  "EnableAvifVary": true,
  "EnableCountryCodeVary": true,
  "EnableCountryStateCodeVary": true,
  "EnableMobileVary": true,
  "EnableCookieVary": true,
  "EnableHostnameVary": true,
  "AWSSigningEnabled": true,
  "LoggingIPAnonymizationEnabled": true,
  "EnableTLS1": true,
  "EnableTLS1_1": true,
  "VerifyOriginSSL": true,
  "ErrorPageEnableCustomCode": true,
  "ErrorPageEnableStatuspageWidget": true,
  "ErrorPageWhitelabel": true,
  "LogForwardingEnabled": true,
  "LogForwardingPort": 123,
  "LoggingSaveToStorage": true,
  "LoggingStorageZoneId": 123,
  "FollowRedirects": true,
  "VideoLibraryId": 123,
  "DnsRecordId": 123,
  "DnsZoneId": 123,
  "OptimizerEnabled": true,
  "OptimizerTunnelEnabled": true,
  "OptimizerDesktopMaxWidth": 2500,
  "OptimizerMobileMaxWidth": 2500,
  "OptimizerImageQuality": 50,
  "OptimizerMobileImageQuality": 50,
  "OptimizerEnableWebP": true,
  "OptimizerPrerenderHtml": true,
  "OptimizerEnableManipulationEngine": true,
  "OptimizerMinifyCSS": true,
  "OptimizerMinifyJavaScript": true,
  "OptimizerWatermarkEnabled": true,
  "OptimizerWatermarkOffset": 123,
  "OptimizerWatermarkMinImageSize": 123,
  "OptimizerAutomaticOptimizationEnabled": true,
  "PermaCacheStorageZoneId": 123,
  "OriginRetries": 123,
  "OriginConnectTimeout": 123,
  "OriginResponseTimeout": 123,
  "UseStaleWhileUpdating": true,
  "UseStaleWhileOffline": true,
  "OriginRetry5XXResponses": true,
  "OriginRetryConnectionTimeout": true,
  "OriginRetryResponseTimeout": true,
  "OriginRetryDelay": 123,
  "OriginShieldEnableConcurrencyLimit": true,
  "OriginShieldMaxConcurrentRequests": 123,
  "EnableSafeHop": true,
  "CacheErrorResponses": true,
  "OriginShieldQueueMaxWaitTime": 123,
  "OriginShieldMaxQueuedRequests": 123,
  "OptimizerForceClasses": true,
  "UseBackgroundUpdate": true,
  "EnableAutoSSL": true,
  "EnableQueryStringOrdering": true,
  "ShieldDDosProtectionEnabled": true,
  "EnableRequestCoalescing": true,
  "RequestCoalescingTimeout": 123,
  "DisableLetsEncrypt": true,
  "EnableBunnyImageAi": true,
  "PreloadingScreenEnabled": true,
  "PreloadingScreenShowOnFirstVisit": true,
  "PreloadingScreenCodeEnabled": true,
  "PreloadingScreenDelay": 123,
  "EUUSDiscount": 123,
  "SouthAmericaDiscount": 123,
  "AfricaDiscount": 123,
  "AsiaOceaniaDiscount": 123,
  "BlockNoneReferrer": true,
  "CacheVersion": 123,
  "OptimizerEnableUpscaling": true,
  "EnableWebSockets": true,
  "MaxWebSocketConnections": 123,
  "Name": "<string>",
  "OriginUrl": "<string>",
  "Hostnames": [
    {
      "Id": 123,
      "ForceSSL": true,
      "IsSystemHostname": true,
      "IsManagedHostname": true,
      "HasCertificate": true,
      "Value": "<string>",
      "Certificate": "<string>",
      "CertificateKey": "<string>",
      "CertificateKeyType": "Ecdsa",
      "CertificateProvisionType": "Unknown"
    }
  ],
  "EdgeScriptExecutionPhase": "Cache",
  "MiddlewareScriptId": 123,
  "MagicContainersAppId": "<string>",
  "MagicContainersEndpointId": "<string>",
  "AllowedReferrers": [
    "<string>"
  ],
  "BlockedReferrers": [
    "<string>"
  ],
  "BlockedIps": [
    "<string>"
  ],
  "ZoneSecurityKey": "<string>",
  "OriginHostHeader": "<string>",
  "Type": "Premium",
  "AccessControlOriginHeaderExtensions": [
    "<string>"
  ],
  "BudgetRedirectedCountries": [
    "<string>"
  ],
  "BlockedCountries": [
    "<string>"
  ],
  "EdgeRules": [
    {
      "Guid": "<string>",
      "ActionType": "ForceSSL",
      "ActionParameter1": "<string>",
      "ActionParameter2": "<string>",
      "ActionParameter3": "<string>",
      "Triggers": [
        {
          "Type": "Url",
          "PatternMatchingType": 0,
          "PatternMatches": [
            "<string>"
          ],
          "Parameter1": "<string>"
        }
      ],
      "ExtraActions": [
        {
          "ActionType": "<unknown>",
          "ActionParameter1": "<string>",
          "ActionParameter2": "<string>",
          "ActionParameter3": "<string>"
        }
      ],
      "TriggerMatchingType": 0,
      "Description": "<string>",
      "Enabled": true,
      "OrderIndex": 123
    }
  ],
  "CookieVaryParameters": [
    "<string>"
  ],
  "CnameDomain": "<string>",
  "AWSSigningKey": "<string>",
  "AWSSigningSecret": "<string>",
  "AWSSigningRegionName": "<string>",
  "ErrorPageCustomCode": "<string>",
  "ErrorPageStatuspageCode": "<string>",
  "OriginShieldZoneCode": "<string>",
  "LogForwardingHostname": "<string>",
  "LogForwardingToken": "<string>",
  "LogForwardingProtocol": "UDP",
  "DnsRecordValue": "<string>",
  "OptimizerWatermarkUrl": "<string>",
  "OptimizerWatermarkPosition": {},
  "PermaCacheType": "Automatic",
  "QueryStringVaryParameters": [
    "<string>"
  ],
  "OptimizerClasses": [
    {
      "Name": "<string>",
      "Properties": {}
    }
  ],
  "OptimizerStaticHtmlWordPressPath": "<string>",
  "OptimizerStaticHtmlWordPressBypassCookie": "<string>",
  "LogAnonymizationType": "OneDigit",
  "LogFormat": "Plain",
  "LogForwardingFormat": "Plain",
  "ShieldDDosProtectionType": "DetectOnly",
  "OriginType": "OriginUrl",
  "OriginLinkValue": "<string>",
  "BunnyAiImageBlueprints": [
    {
      "Name": "<string>",
      "Properties": {}
    }
  ],
  "PreloadingScreenCode": "<string>",
  "PreloadingScreenLogoUrl": "<string>",
  "PreloadingScreenTheme": "Light",
  "RoutingFilters": [
    "<string>"
  ],
  "StickySessionType": "Off",
  "StickySessionCookieName": "<string>",
  "StickySessionClientHeaders": "<string>",
  "UserId": "<string>"
}

Authorizations

​
AccessKey
string
header
required

API Access Key authorization header

Path Parameters

​
id
integer<int64>
required

The ID of the Pull Zone that should be updated

Body

​
PreloadingScreenShowOnFirstVisit
boolean
required

Determines if the preloading screen is shown on the first load from a user.

​
OriginUrl
string | null

Sets the origin URL of the Pull Zone

​
AllowedReferrers
string[] | null

Sets the list of referrer hostnames that are allowed to access the pull zone. Requests containing the header Referer: hostname that is not on the list will be rejected. If empty, all the referrers are allowed

​
BlockedReferrers
string[] | null

Sets the list of referrer hostnames that are blocked from accessing the pull zone.

​
BlockNoneReferrer
boolean | null
​
BlockedIps
string[] | null

Sets the list of IPs that are blocked from accessing the pull zone. Requests coming from the following IPs will be rejected. If empty, all the IPs will be allowed

​
EnableGeoZoneUS
boolean | null

Determines if the delivery from the North America region should be enabled for this pull zone

​
EnableGeoZoneEU
boolean | null

Determines if the delivery from the Europe region should be enabled for this pull zone

​
EnableGeoZoneASIA
boolean | null

Determines if the delivery from the Asia / Oceania regions should be enabled for this pull zone

​
EnableGeoZoneSA
boolean | null

Determines if the delivery from the South America region should be enabled for this pull zone

​
EnableGeoZoneAF
boolean | null

Determines if the delivery from the Africa region should be enabled for this pull zone

​
BlockRootPathAccess
boolean | null

Determines if the zone should block requests to the root of the zone.

​
BlockPostRequests
boolean | null

Determines if the POST requests to this zone should be rejected.

​
EnableQueryStringOrdering
boolean | null

Determines if the query string ordering should be enabled.

​
EnableWebpVary
boolean | null

Determines if the WebP Vary feature should be enabled.

​
EnableAvifVary
boolean | null

Determines if the AVIF Vary feature should be enabled.

​
EnableMobileVary
boolean | null

Determines if the Mobile Vary feature is enabled.

​
EnableCountryCodeVary
boolean | null

Determines if the Country Code Vary feature should be enabled.

​
EnableCountryStateCodeVary
boolean | null

Determines if the Country State Code Vary feature should be enabled.

​
EnableHostnameVary
boolean | null

Determines if the Hostname Vary feature should be enabled.

​
EnableCacheSlice
boolean | null

Determines if cache slicing (Optimize for video) should be enabled for this zone

​
ZoneSecurityEnabled
boolean | null

Determines if the zone token authentication security should be enabled

​
ZoneSecurityIncludeHashRemoteIP
boolean | null

Determines if the token authentication IP validation should be enabled

​
IgnoreQueryStrings
boolean | null

Determines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String)

​
MonthlyBandwidthLimit
integer<int64> | null

Sets the monthly limit of bandwidth in bytes that the pullzone is allowed to use

​
AccessControlOriginHeaderExtensions
string[] | null

Sets the list of extensions that will return the CORS headers

​
EnableAccessControlOriginHeader
boolean | null

Determines if CORS headers should be enabled

​
DisableCookies
boolean | null

Determines if the Pull Zone should automatically remove cookies from the responses

​
BudgetRedirectedCountries
string[] | null

Sets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region

​
BlockedCountries
string[] | null

Sets the list of two letter Alpha2 country codes that will be blocked from accessing the zone

​
CacheControlMaxAgeOverride
integer<int64> | null

Sets the cache control override setting for this zone

​
CacheControlPublicMaxAgeOverride
integer<int64> | null

Sets the browser cache control override setting for this zone

​
CacheControlBrowserMaxAgeOverride
integer<int64> | null

(Deprecated) Sets the browser cache control override setting for this zone

​
AddHostHeader
boolean | null

Determines if the zone should forward the requested host header to the origin

​
AddCanonicalHeader
boolean | null

Determines if the canonical header should be added by this zone

​
EnableLogging
boolean | null

Determines if the logging should be enabled for this zone

​
LoggingIPAnonymizationEnabled
boolean | null

Determines if the log anonoymization should be enabled

​
PermaCacheStorageZoneId
integer<int64> | null

The ID of the storage zone that should be used as the Perma-Cache

​
PermaCacheType
enum<string>

Determines Perma-Cache behavior

Available options:
Automatic,
Manual
Example:

"Automatic"

​
AWSSigningEnabled
boolean | null

Determines if the AWS signing should be enabled or not

​
AWSSigningKey
string | null

Sets the AWS signing key

​
AWSSigningRegionName
string | null

Sets the AWS signing region name

​
AWSSigningSecret
string | null

Sets the AWS signing secret key

​
EnableOriginShield
boolean | null

Determines if the origin shield should be enabled

​
OriginShieldZoneCode
string | null

Determines the zone code where the origin shield should be set up

​
EnableTLS1
boolean | null

Determines if the TLS 1 should be enabled on this zone

​
EnableTLS1_1
boolean | null

Determines if the TLS 1.1 should be enabled on this zone

​
CacheErrorResponses
boolean | null

Determines if the cache error responses should be enabled on the zone

​
VerifyOriginSSL
boolean | null

Determines if the SSL certificate should be verified when connecting to the origin

​
LogForwardingEnabled
boolean | null

Sets the log forwarding token for the zone

​
LogForwardingHostname
string | null

Sets the log forwarding destination hostname for the zone

​
LogForwardingPort
integer<int32> | null

Sets the log forwarding port for the zone

​
LogForwardingToken
string | null

Sets the log forwarding token for the zone

​
LogForwardingProtocol
enum<string>

Sets the log forwarding protocol type

Available options:
UDP,
TCP,
TCPEncrypted,
DataDog
Example:

"UDP"

​
LoggingSaveToStorage
boolean | null

Determines if the logging permanent storage should be enabled

​
LoggingStorageZoneId
integer<int64> | null

Sets the Storage Zone id that should contain the logs from this Pull Zone

​
FollowRedirects
boolean | null

Determines if the zone should follow redirects return by the oprigin and cache the response

​
ConnectionLimitPerIPCount
integer<int32> | null

Determines the maximum number of connections per IP that will be allowed to connect to this Pull Zone

​
RequestLimit
integer<int32> | null

Determines the maximum number of requests per second that will be allowed to connect to this Pull Zone

​
LimitRateAfter
number<double> | null

Determines the amount of traffic transferred before the client is limited

​
LimitRatePerSecond
integer<int32> | null

Determines the maximum number of requests per second coming from a single IP before it is blocked.

​
BurstSize
integer<int32> | null

Determines the maximum burst requests before an IP is blocked

​
ErrorPageEnableCustomCode
boolean | null

Determines if custom error page code should be enabled.

​
ErrorPageCustomCode
string | null

Contains the custom error page code that will be returned

​
ErrorPageEnableStatuspageWidget
boolean | null

Determines if the statuspage widget should be displayed on the error pages

​
ErrorPageStatuspageCode
string | null

The statuspage code that will be used to build the status widget

​
ErrorPageWhitelabel
boolean | null

Determines if the error pages should be whitelabel or not

​
OptimizerEnabled
boolean | null

Determines if the optimizer should be enabled for this zone

​
OptimizerTunnelEnabled
boolean | null

Determines if the optimizer origin tunnel system should be enabled for this zone

​
OptimizerDesktopMaxWidth
integer<int32> | null

Determines the maximum automatic image size for desktop clients

Required range: 0 <= x <= 5000
​
OptimizerMobileMaxWidth
integer<int32> | null

Determines the maximum automatic image size for mobile clients

Required range: 0 <= x <= 5000
​
OptimizerImageQuality
integer<int32> | null

Determines the image quality for desktop clients

Required range: 1 <= x <= 100
​
OptimizerMobileImageQuality
integer<int32> | null

Determines the image quality for mobile clients

Required range: 1 <= x <= 100
​
OptimizerEnableWebP
boolean | null

Determines if the WebP optimization should be enabled

​
OptimizerPrerenderHtml
boolean | null

Determines if the SEO HTML prerender should be enabled

​
OptimizerEnableManipulationEngine
boolean | null

Determines the image manipulation should be enabled

​
OptimizerMinifyCSS
boolean | null

Determines if the CSS minifcation should be enabled

​
OptimizerMinifyJavaScript
boolean | null

Determines if the JavaScript minifcation should be enabled

​
OptimizerWatermarkEnabled
boolean | null

Determines if image watermarking should be enabled

​
OptimizerWatermarkUrl
string | null

Sets the URL of the watermark image

​
OptimizerWatermarkPosition
object

Sets the position of the watermark image

​
OptimizerWatermarkOffset
number<double> | null

Sets the offset of the watermark image

​
OptimizerWatermarkMinImageSize
integer<int32> | null

Sets the minimum image size to which the watermark will be added

​
OptimizerAutomaticOptimizationEnabled
boolean | null

Determines if the automatic image optimization should be enabled

​
OptimizerClasses
object[] | null

Determines the list of optimizer classes

​
OptimizerForceClasses
boolean | null

Determines if the optimizer classes should be forced

​
OptimizerStaticHtmlWordPressPath
string | null

Wordpress html path which should be bypassed by permacache in edge rule

​
OptimizerStaticHtmlWordPressBypassCookie
string | null

Wordpress cookie which should be bypassed by permacache in edge rule

​
Type
enum<string>

The type of the pull zone. Premium = 0, Volume = 1

Available options:
Premium,
Volume
Example:

"Premium"

​
OriginRetries
integer<int32> | null

The number of retries to the origin server

​
OriginConnectTimeout
integer<int32> | null

The amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry.

​
OriginResponseTimeout
integer<int32> | null

The amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry.

​
UseStaleWhileUpdating
boolean | null

Determines if we should use stale cache while cache is updating

​
UseStaleWhileOffline
boolean | null

Determines if we should use stale cache while the origin is offline

​
OriginRetry5XXResponses
boolean | null

Determines if we should retry the request in case of a 5XX response.

​
OriginRetryConnectionTimeout
boolean | null

Determines if we should retry the request in case of a connection timeout.

​
OriginRetryResponseTimeout
boolean | null

Determines if we should retry the request in case of a response timeout.

​
OriginRetryDelay
integer<int32> | null

Determines the amount of time that the CDN should wait before retrying an origin request.

​
DnsOriginPort
integer<int32> | null

Determines the origin port of the pull zone.

​
DnsOriginScheme
string | null

Determines the origin scheme of the pull zone.

​
QueryStringVaryParameters
string[] | null
​
OriginShieldEnableConcurrencyLimit
boolean | null

Determines if the origin shield concurrency limit is enabled.

​
OriginShieldMaxConcurrentRequests
integer<int32> | null

Determines the number of maximum concurrent requests allowed to the origin.

Required range: 1 <= x <= 10000
​
EnableCookieVary
boolean | null

Determines if the Cookie Vary feature is enabled.

​
CookieVaryParameters
string[] | null
​
EnableSafeHop
boolean | null
​
OriginShieldQueueMaxWaitTime
integer<int32> | null

Determines the max queue wait time

​
OriginShieldMaxQueuedRequests
integer<int32> | null

Determines the max number of origin requests that will remain in the queue

Required range: 0 <= x <= 30000
​
UseBackgroundUpdate
boolean | null

Determines if cache update is performed in the background.

​
EnableAutoSSL
boolean | null

If set to true, any hostnames added to this Pull Zone will automatically enable SSL.

​
LogAnonymizationType
enum<string>

Sets the log anonymization type for this pull zone

Available options:
OneDigit,
Drop
Example:

"OneDigit"

​
StorageZoneId
integer<int64> | null

The ID of the storage zone that will be used as the origin

​
EdgeScriptId
integer<int64> | null

The ID of the edge script that will be used as the origin

​
MiddlewareScriptId
integer<int64> | null

The ID of the middleware script

​
EdgeScriptExecutionPhase
enum<string>

The execution phase of the edge script

Available options:
Cache,
LoadBalancer
Example:

"Cache"

​
OriginType
enum<string>

Determine the type of the origin for this Pull Zone

Available options:
OriginUrl,
DnsAccelerate,
StorageZone,
LoadBalancer,
EdgeScript,
MagicContainers,
PushZone
Example:

"OriginUrl"

​
MagicContainersAppId
string | null
​
MagicContainersEndpointId
string | null
​
LogFormat
enum<string>

0 = Plain
1 = JSON

Available options:
Plain,
JSON
Example:

"Plain"

​
LogForwardingFormat
enum<string>

0 = Plain
1 = JSON

Available options:
Plain,
JSON
Example:

"Plain"

​
ShieldDDosProtectionType
enum<string>

0 = DetectOnly
1 = ActiveStandard
2 = ActiveAggressive

Available options:
DetectOnly,
ActiveStandard,
ActiveAggressive
Example:

"DetectOnly"

​
ShieldDDosProtectionEnabled
boolean | null
​
OriginHostHeader
string | null

Sets the host header that will be sent to the origin

​
EnableSmartCache
boolean | null
​
EnableRequestCoalescing
boolean | null

Determines if request coalescing is currently enabled.

​
RequestCoalescingTimeout
integer<int32> | null

Determines the lock time for coalesced requests.

​
DisableLetsEncrypt
boolean | null

If set to true, the built-in let's encrypt will be disabled and requests are passed to the origin.

​
EnableBunnyImageAi
boolean | null
​
BunnyAiImageBlueprints
object[] | null
​
PreloadingScreenEnabled
boolean | null

Determines if the preloading screen is currently enabled

​
PreloadingScreenCode
string | null

The custom preloading screen coed

​
PreloadingScreenLogoUrl
string | null

The preloading screen logo URL

​
PreloadingScreenTheme
enum<string>

The currently configured preloading screem theme. (0 - Light, 1 - Dark)

Available options:
Light,
Dark
Example:

"Light"

​
PreloadingScreenCodeEnabled
boolean | null

Determines if the custom preloader screen should be enabled

​
PreloadingScreenDelay
integer<int32> | null

The delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms)

Required range: 0 <= x <= 10000
​
RoutingFilters
string[] | null

The list of routing filters enabled for this zone

​
StickySessionType
enum<string>

Whether to use a Sticky Session mechanism for this pull zone

Available options:
Off,
On
Example:

"Off"

​
StickySessionCookieName
string | null

Sticky Session Cookie Name

​
StickySessionClientHeaders
string | null

A set of comma-separated header names used to identify clients

​
OptimizerEnableUpscaling
boolean | null

Determines if Optimizer should automatically upscale images

​
EnableWebSockets
boolean | null

Determines if WebSocket connections are allowed for this Pull Zone.

​
MaxWebSocketConnections
integer<int32> | null

Response

The Pull Zone was successfuly updated

​
Id
integer<int64>
required

The unique ID of the pull zone.

​
Enabled
boolean
required

True unless reached resource limits or account owning it ran out of funds.

​
Suspended
boolean
required
​
StorageZoneId
integer<int64>
required

The ID of the storage zone that the pull zone is linked to

​
EdgeScriptId
integer<int64>
required

The ID of the edge script that the pull zone is linked to

​
EnableGeoZoneUS
boolean
required

Determines if the delivery from the North American region is enabled for this pull zone

​
EnableGeoZoneEU
boolean
required

Determines if the delivery from the European region is enabled for this pull zone

​
EnableGeoZoneASIA
boolean
required

Determines if the delivery from the Asian / Oceanian region is enabled for this pull zone

​
EnableGeoZoneSA
boolean
required

Determines if the delivery from the South American region is enabled for this pull zone

​
EnableGeoZoneAF
boolean
required

Determines if the delivery from the Africa region is enabled for this pull zone

​
ZoneSecurityEnabled
boolean
required

True if the URL secure token authentication security is enabled

​
ZoneSecurityIncludeHashRemoteIP
boolean
required

True if the zone security hash should include the remote IP

​
IgnoreQueryStrings
boolean
required

True if the Pull Zone is ignoring query strings when serving cached objects

​
MonthlyBandwidthLimit
integer<int64>
required

The monthly limit of bandwidth in bytes that the pullzone is allowed to use

​
MonthlyBandwidthUsed
integer<int64>
required

The amount of bandwidth in bytes that the pull zone used this month

​
MonthlyCharges
number<decimal>
required

The total monthly charges for this so zone so far

​
AddHostHeader
boolean
required

Determines if the Pull Zone should forward the current hostname to the origin

​
EnableAccessControlOriginHeader
boolean
required

Determines if the CORS headers should be enabled

​
DisableCookies
boolean
required

Determines if the cookies are disabled for the pull zone

​
EnableOriginShield
boolean
required

If true the server will use the origin shield feature

​
CacheControlMaxAgeOverride
integer<int64>
required

The override cache time for the pull zone

​
CacheControlPublicMaxAgeOverride
integer<int64>
required

The override cache time for the pull zone for the end client

​
BurstSize
integer<int32>
required

Excessive requests are delayed until their number exceeds the maximum burst size.

​
RequestLimit
integer<int32>
required

Max number of requests per IP per second

​
BlockRootPathAccess
boolean
required

If true, access to root path will return a 403 error

​
BlockPostRequests
boolean
required

If true, POST requests to the zone will be blocked

​
LimitRatePerSecond
number<double>
required

The maximum rate at which the zone will transfer data in kb/s. 0 for unlimited

​
LimitRateAfter
number<double>
required

The amount of data after the rate limit will be activated

​
ConnectionLimitPerIPCount
integer<int32>
required

The number of connections limited per IP for this zone

​
PriceOverride
number<decimal>
required

The custom price override for this zone. Unit is $/Byte.

​
OptimizerPricing
number<decimal>
required

Monthly pricing for Bunny Optimizer for this pull zone

​
AddCanonicalHeader
boolean
required

Determines if the Add Canonical Header is enabled for this Pull Zone

​
EnableLogging
boolean
required

Determines if the logging is enabled for this Pull Zone

​
EnableCacheSlice
boolean
required

Determines if the cache slice (Optimize for video) feature is enabled for the Pull Zone

​
EnableSmartCache
boolean
required

Determines if smart caching is enabled for this zone

​
EnableWebPVary
boolean
required

Determines if the WebP Vary feature is enabled.

​
EnableAvifVary
boolean
required

Determines if the AVIF Vary feature is enabled.

​
EnableCountryCodeVary
boolean
required

Determines if the Country Code Vary feature is enabled.

​
EnableCountryStateCodeVary
boolean
required

Determines if the Country State Code Vary feature should be enabled.

​
EnableMobileVary
boolean
required

Determines if the Mobile Vary feature is enabled.

​
EnableCookieVary
boolean
required

Determines if the Cookie Vary feature is enabled.

​
EnableHostnameVary
boolean
required

Determines if the Hostname Vary feature is enabled.

​
AWSSigningEnabled
boolean
required

Determines if the AWS Signing is enabled

​
LoggingIPAnonymizationEnabled
boolean
required

Determines if the TLS 1 is enabled on the Pull Zone

​
EnableTLS1
boolean
required

Determines if the TLS 1 is enabled on the Pull Zone

​
EnableTLS1_1
boolean
required

Determines if the TLS 1.1 is enabled on the Pull Zone

​
VerifyOriginSSL
boolean
required

Determines if the Pull Zone should verify the origin SSL certificate

​
ErrorPageEnableCustomCode
boolean
required

Determines if custom error page code should be enabled.

​
ErrorPageEnableStatuspageWidget
boolean
required

Determines if the statuspage widget should be displayed on the error pages

​
ErrorPageWhitelabel
boolean
required

Determines if the error pages should be whitelabel or not

​
LogForwardingEnabled
boolean
required

Determines if the log forawrding is enabled

​
LogForwardingPort
integer<int32>
required

The log forwarding port

​
LoggingSaveToStorage
boolean
required

Determines if the permanent logging feature is enabled

​
LoggingStorageZoneId
integer<int64>
required

The ID of the logging storage zone that is configured for this Pull Zone

​
FollowRedirects
boolean
required

Determines if the zone will follow origin redirects

​
VideoLibraryId
integer<int64>
required

The ID of the video library that the zone is linked to

​
DnsRecordId
integer<int64>
required

The ID of the DNS record tied to this pull zone

​
DnsZoneId
integer<int64>
required

The ID of the DNS zone tied to this pull zone

​
OptimizerEnabled
boolean
required

Determines if the optimizer should be enabled for this zone

​
OptimizerTunnelEnabled
boolean
required

Determines if the optimizer origin tunnel system is enabled for this zone

​
OptimizerDesktopMaxWidth
integer<int32>
required

Determines the maximum automatic image size for desktop clients

Required range: 0 <= x <= 5000
​
OptimizerMobileMaxWidth
integer<int32>
required

Determines the maximum automatic image size for mobile clients

Required range: 0 <= x <= 5000
​
OptimizerImageQuality
integer<int32>
required

Determines the image quality for desktop clients

Required range: 1 <= x <= 100
​
OptimizerMobileImageQuality
integer<int32>
required

Determines the image quality for mobile clients

Required range: 1 <= x <= 100
​
OptimizerEnableWebP
boolean
required

Determines if the WebP optimization should be enabled

​
OptimizerPrerenderHtml
boolean
required

Determines if the SEO HTML prerender is enabled

​
OptimizerEnableManipulationEngine
boolean
required

Determines the image manipulation should be enabled

​
OptimizerMinifyCSS
boolean
required

Determines if the CSS minifcation should be enabled

​
OptimizerMinifyJavaScript
boolean
required

Determines if the JavaScript minifcation should be enabled

​
OptimizerWatermarkEnabled
boolean
required

Determines if image watermarking should be enabled

​
OptimizerWatermarkOffset
number<double>
required

Sets the offset of the watermark image

​
OptimizerWatermarkMinImageSize
integer<int32>
required

Sets the minimum image size to which the watermark will be added

​
OptimizerAutomaticOptimizationEnabled
boolean
required

Determines if the automatic image optimization should be enabled

​
PermaCacheStorageZoneId
integer<int64>
required

The IP of the storage zone used for Perma-Cache

​
OriginRetries
integer<int32>
required

The number of retries to the origin server

​
OriginConnectTimeout
integer<int32>
required

The amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry.

​
OriginResponseTimeout
integer<int32>
required

The amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry.

​
UseStaleWhileUpdating
boolean
required

Determines if we should use stale cache while cache is updating

​
UseStaleWhileOffline
boolean
required

Determines if we should use stale cache while the origin is offline

​
OriginRetry5XXResponses
boolean
required

Determines if we should retry the request in case of a 5XX response.

​
OriginRetryConnectionTimeout
boolean
required

Determines if we should retry the request in case of a connection timeout.

​
OriginRetryResponseTimeout
boolean
required

Determines if we should retry the request in case of a response timeout.

​
OriginRetryDelay
integer<int32>
required

Determines the amount of time that the CDN should wait before retrying an origin request.

​
OriginShieldEnableConcurrencyLimit
boolean
required

Determines if the origin shield concurrency limit is enabled.

​
OriginShieldMaxConcurrentRequests
integer<int32>
required

Determines the number of maximum concurrent requests allowed to the origin.

​
EnableSafeHop
boolean
required
​
CacheErrorResponses
boolean
required

Determines if bunny.net should be caching error responses

​
OriginShieldQueueMaxWaitTime
integer<int32>
required

Determines the max queue wait time

​
OriginShieldMaxQueuedRequests
integer<int32>
required

Determines the max number of origin requests that will remain in the queu

​
OptimizerForceClasses
boolean
required

Determines if the optimizer class list should be enforced

​
UseBackgroundUpdate
boolean
required

Determines if cache update is performed in the background.

​
EnableAutoSSL
boolean
required

If set to true, any hostnames added to this Pull Zone will automatically enable SSL.

​
EnableQueryStringOrdering
boolean
required

If set to true the query string ordering property is enabled.

​
ShieldDDosProtectionEnabled
boolean
required
​
EnableRequestCoalescing
boolean
required

Determines if request coalescing is currently enabled.

​
RequestCoalescingTimeout
integer<int32>
required

Determines the lock time for coalesced requests.

​
DisableLetsEncrypt
boolean
required

If true, the built-in let's encrypt is disabled and requests are passed to the origin.

​
EnableBunnyImageAi
boolean
required
​
PreloadingScreenEnabled
boolean
required

Determines if the preloading screen is currently enabled

​
PreloadingScreenShowOnFirstVisit
boolean
required

Determines if the preloading screen is shown on the first load from a user.

​
PreloadingScreenCodeEnabled
boolean
required

Determines if the custom preloader screen is enabled

​
PreloadingScreenDelay
integer<int32>
required

The delay in miliseconds after which the preloading screen will be desplayed

​
EUUSDiscount
integer<int32>
required

The Pull Zone specific pricing discount for EU and US region.

​
SouthAmericaDiscount
integer<int32>
required

The Pull Zone specific pricing discount for South America region.

​
AfricaDiscount
integer<int32>
required

The Pull Zone specific pricing discount for Africa region.

​
AsiaOceaniaDiscount
integer<int32>
required

The Pull Zone specific pricing discount for Asia & Oceania region.

​
BlockNoneReferrer
boolean
required

Determines if direct access to files will be blocked if not coming from allowed referrers

​
CacheVersion
integer<int64>
required
​
OptimizerEnableUpscaling
boolean
required

Whether to automatically upscale assets when using Optimizer.

​
EnableWebSockets
boolean
required

Determines if WebSocket connections are allowed for this Pull Zone.

​
MaxWebSocketConnections
integer<int32>
required

The maximum global simultaneous WebSocket connections allowed for this Pull Zone.

​
Name
string | null

The name of the pull zone.

​
OriginUrl
string | null

The origin URL of the pull zone where the files are fetched from.

​
Hostnames
object[] | null

The list of hostnames linked to this Pull Zone

​
EdgeScriptExecutionPhase
enum<string>

The phase of the request where the script will be executed

Available options:
Cache,
LoadBalancer
Example:

"Cache"

​
MiddlewareScriptId
integer<int64> | null
​
MagicContainersAppId
string | null

The ID of the Magic Container application the pull zone is linked to

​
MagicContainersEndpointId
string | null

The ID of the Magic Container Endpoint the pull zone is linked to

​
AllowedReferrers
string[] | null

The list of referrer hostnames that are allowed to access the pull zone.Requests containing the header Referer: hostname that is not on the list will be rejected.If empty, all the referrers are allowed

​
BlockedReferrers
string[] | null

The list of referrer hostnames that are allowed to access the pull zone. Requests containing the header Referer: hostname that is not on the list will be rejected. If empty, all the referrers are allowed

​
BlockedIps
string[] | null

The list of IPs that are blocked from accessing the pull zone. Requests coming from the following IPs will be rejected. If empty, all the IPs will be allowed

​
ZoneSecurityKey
string | null

The security key used for secure URL token authentication

​
OriginHostHeader
string | null

Determines the host header that will be sent to the origin

​
Type
enum<string>

The type of the pull zone. Premium = 0, Volume = 1

Available options:
Premium,
Volume
Example:

"Premium"

​
AccessControlOriginHeaderExtensions
string[] | null

The list of extensions that will return the CORS headers

​
BudgetRedirectedCountries
string[] | null

The list of budget redirected countries with the two-letter Alpha2 ISO codes

​
BlockedCountries
string[] | null

The list of blocked countries with the two-letter Alpha2 ISO codes

​
EdgeRules
object[] | null

The list of edge rules on this Pull Zone

​
CookieVaryParameters
string[] | null

Contains the list of vary parameters that will be used for vary cache by cookie string. If empty, cookie vary will not be used.

​
CnameDomain
string | null

The CNAME domain of the pull zone for setting up custom hostnames

​
AWSSigningKey
string | null

The AWS Signing region key

​
AWSSigningSecret
string | null

The AWS Signing region secret

​
AWSSigningRegionName
string | null

The AWS Signing region name

​
ErrorPageCustomCode
string | null

Contains the custom error page code that will be returned

​
ErrorPageStatuspageCode
string | null

The statuspage code that will be used to build the status widget

​
OriginShieldZoneCode
string | null

The zone code of the origin shield

​
LogForwardingHostname
string | null

The log forwarding hostname

​
LogForwardingToken
string | null

The log forwarding token value

​
LogForwardingProtocol
enum<string>

Determines the log forwarding protocol type

Available options:
UDP,
TCP,
TCPEncrypted,
DataDog
Example:

"UDP"

​
DnsRecordValue
string | null

The cached version of the DNS record value

​
OptimizerWatermarkUrl
string | null

Sets the URL of the watermark image

​
OptimizerWatermarkPosition
object

Sets the position of the watermark image

​
PermaCacheType
enum<string>

Determines Perma-Cache behavior

Available options:
Automatic,
Manual
Example:

"Automatic"

​
QueryStringVaryParameters
string[] | null

Contains the list of vary parameters that will be used for vary cache by query string. If empty, all parameters will be used to construct the key

​
OptimizerClasses
object[] | null

Contains the list of optimizer classes

​
OptimizerStaticHtmlWordPressPath
string | null

Wordpress html path which should be bypassed by permacache in edge rule

​
OptimizerStaticHtmlWordPressBypassCookie
string | null

Wordpress cookie which should be bypassed by permacache in edge rule

​
LogAnonymizationType
enum<string>

Gets the log anonymization type for this pull zone

Available options:
OneDigit,
Drop
Example:

"OneDigit"

​
LogFormat
enum<string>

0 = Plain
1 = JSON

Available options:
Plain,
JSON
Example:

"Plain"

​
LogForwardingFormat
enum<string>

0 = Plain
1 = JSON

Available options:
Plain,
JSON
Example:

"Plain"

​
ShieldDDosProtectionType
enum<string>

0 = DetectOnly
1 = ActiveStandard
2 = ActiveAggressive

Available options:
DetectOnly,
ActiveStandard,
ActiveAggressive
Example:

"DetectOnly"

​
OriginType
enum<string>

The type of the origin for this Pull Zone

Available options:
OriginUrl,
DnsAccelerate,
StorageZone,
LoadBalancer,
EdgeScript,
MagicContainers,
PushZone
Example:

"OriginUrl"

​
OriginLinkValue
string | null

Returns the link short preview value for the pull zone origin connection.

​
BunnyAiImageBlueprints
object[] | null
​
PreloadingScreenCode
string | null

The custom preloading screen code

​
PreloadingScreenLogoUrl
string | null

The preloading screen logo URL

​
PreloadingScreenTheme
enum<string>

The currently configured preloading screem theme. (0 - Light, 1 - Dark)

Available options:
Light,
Dark
Example:

"Light"

​
RoutingFilters
string[] | null

The list of routing filters enabled for this zone

​
StickySessionType
enum<string>

Whether to use a Sticky Session mechanism for this pull zone

Available options:
Off,
On
Example:

"Off"

​
StickySessionCookieName
string | null

Sticky Session Cookie Name

​
StickySessionClientHeaders
string | null

A set of comma-separated header names used to identify clients

​
UserId
string | null

User Id of the pull zone owner