Get Pull Zone

Get Pull Zone

curl --request GET \
  --url https://api.bunny.net/pullzone/{id} \
  --header 'AccessKey: <api-key>'

{
  "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>"
}

GET

pullzone

{id}

Get Pull Zone

curl --request GET \
  --url https://api.bunny.net/pullzone/{id} \
  --header 'AccessKey: <api-key>'

{
  "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

integer<int64>

required

The ID of the Pull Zone that should be returned

Query Parameters

includeCertificate

boolean

default:false

Determines if the result hostnames should contain the SSL certificate

Response

The Pull Zone with the requested 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.

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.

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

Show child attributes

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

Show child attributes

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

Show child attributes

OptimizerStaticHtmlWordPressPath

string | null

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

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

Show child attributes

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"

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

Add Pull Zone

Update Pull Zone

⌘I

API Reference

Core Platform API

Origin Errors API

Storage API

Stream API

Shield API

Edge Scripting API

Authorizations

Path Parameters

Query Parameters

Response