v1

latestOpenAPI 3.0.42026-07-26263457588.1 KB
Pull Zone

Get Pull Zone

get/pullzone/{id}

Path parameters

idinteger required

The ID of the Pull Zone that should be returned

Query parameters

includeCertificateboolean

Determines if the result hostnames should contain the SSL certificate

Response

The Pull Zone with the requested ID

Idinteger

The unique ID of the pull zone.

Namestring nullable

The name of the pull zone.

OriginUrlstring nullable

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

Enabledboolean

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

Suspendedboolean
StorageZoneIdinteger

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

EdgeScriptIdinteger

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

EdgeScriptExecutionPhase0 | 1

0 = Cache 1 = LoadBalancer

MiddlewareScriptIdinteger nullable
MagicContainersAppIdstring nullable

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

MagicContainersEndpointIdstring nullable

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

AllowedReferrersstring[] nullable

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

BlockedReferrersstring[] nullable

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

BlockedIpsstring[] nullable

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

EnableGeoZoneUSboolean

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

EnableGeoZoneEUboolean

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

EnableGeoZoneASIAboolean

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

EnableGeoZoneSAboolean

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

EnableGeoZoneAFboolean

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

IpFamilyPolicy0 | 1 | 2 | 3

0 = IPv4Only 1 = DualStack 2 = DualStackPreferIPv6 3 = IPv6Only

ZoneSecurityEnabledboolean

True if the URL secure token authentication security is enabled

ZoneSecurityKeystring nullable

The security key used for secure URL token authentication

ZoneSecurityIncludeHashRemoteIPboolean

True if the zone security hash should include the remote IP

IgnoreQueryStringsboolean

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

MonthlyBandwidthLimitinteger

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

MonthlyBandwidthUsedinteger

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

MonthlyChargesnumber

The total monthly charges for this so zone so far

AddHostHeaderboolean

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

OriginHostHeaderstring nullable

Determines the host header that will be sent to the origin

Type0 | 1

0 = Premium 1 = Volume

AccessControlOriginHeaderExtensionsstring[] nullable

The list of extensions that will return the CORS headers

EnableAccessControlOriginHeaderboolean

Determines if the CORS headers should be enabled

DisableCookiesboolean

Determines if the cookies are disabled for the pull zone

BudgetRedirectedCountriesstring[] nullable

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

BlockedCountriesstring[] nullable

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

EnableOriginShieldboolean

If true the server will use the origin shield feature

CacheControlMaxAgeOverrideinteger

The override cache time for the pull zone

CacheControlPublicMaxAgeOverrideinteger

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

BurstSizeinteger

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

RequestLimitinteger

Max number of requests per IP per second

BlockRootPathAccessboolean

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

BlockPostRequestsboolean

If true, POST requests to the zone will be blocked

LimitRatePerSecondnumber double

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

LimitRateAfternumber double

The amount of data after the rate limit will be activated

ConnectionLimitPerIPCountinteger

The number of connections limited per IP for this zone

PriceOverridenumber

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

OptimizerPricingnumber

Monthly pricing for Bunny Optimizer for this pull zone

AddCanonicalHeaderboolean

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

EnableLoggingboolean

Determines if the logging is enabled for this Pull Zone

EnableCacheSliceboolean

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

EnableSmartCacheboolean

Determines if smart caching is enabled for this zone

EnableWebPVaryboolean

Determines if the WebP Vary feature is enabled.

EnableAvifVaryboolean

Determines if the AVIF Vary feature is enabled.

EnableCountryCodeVaryboolean

Determines if the Country Code Vary feature is enabled.

EnableCountryStateCodeVaryboolean

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

EnableMobileVaryboolean

Determines if the Mobile Vary feature is enabled.

EnableCookieVaryboolean

Determines if the Cookie Vary feature is enabled.

CookieVaryParametersstring[] nullable

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

EnableHostnameVaryboolean

Determines if the Hostname Vary feature is enabled.

CnameDomainstring nullable

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

AWSSigningEnabledboolean

Determines if the AWS Signing is enabled

AWSSigningKeystring nullable

The AWS Signing region key

AWSSigningSecretstring nullable

The AWS Signing region secret

AWSSigningRegionNamestring nullable

The AWS Signing region name

LoggingIPAnonymizationEnabledboolean

Determines if the TLS 1 is enabled on the Pull Zone

EnableTLS1boolean

Determines if the TLS 1 is enabled on the Pull Zone

EnableTLS1_1boolean

Determines if the TLS 1.1 is enabled on the Pull Zone

VerifyOriginSSLboolean

Determines if the Pull Zone should verify the origin SSL certificate

ErrorPageEnableCustomCodeboolean

Determines if custom error page code should be enabled.

ErrorPageCustomCodestring nullable

Contains the custom error page code that will be returned

ErrorPageEnableStatuspageWidgetboolean

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

ErrorPageStatuspageCodestring nullable

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

ErrorPageWhitelabelboolean

Determines if the error pages should be whitelabel or not

OriginShieldZoneCodestring nullable

The zone code of the origin shield

LogForwardingEnabledboolean

Determines if the log forawrding is enabled

LogForwardingHostnamestring nullable

The log forwarding hostname

LogForwardingPortinteger

The log forwarding port

LogForwardingTokenstring nullable

The log forwarding token value

LogForwardingProtocol0 | 1 | 2 | 3

0 = UDP 1 = TCP 2 = TCPEncrypted 3 = DataDog

LoggingSaveToStorageboolean

Determines if the permanent logging feature is enabled

LoggingStorageZoneIdinteger

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

FollowRedirectsboolean

Determines if the zone will follow origin redirects

VideoLibraryIdinteger

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

DnsRecordIdinteger

The ID of the DNS record tied to this pull zone

DnsZoneIdinteger

The ID of the DNS zone tied to this pull zone

DnsRecordValuestring nullable

The cached version of the DNS record value

OptimizerEnabledboolean

Determines if the optimizer should be enabled for this zone

OptimizerTunnelEnabledboolean

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

OptimizerDesktopMaxWidthinteger

Determines the maximum automatic image size for desktop clients

OptimizerMobileMaxWidthinteger

Determines the maximum automatic image size for mobile clients

OptimizerImageQualityinteger

Determines the image quality for desktop clients

OptimizerMobileImageQualityinteger

Determines the image quality for mobile clients

OptimizerEnableWebPboolean

Determines if the WebP optimization should be enabled

OptimizerPrerenderHtmlboolean

Determines if the SEO HTML prerender is enabled

OptimizerEnableManipulationEngineboolean

Determines the image manipulation should be enabled

OptimizerMinifyCSSboolean

Determines if the CSS minifcation should be enabled

OptimizerMinifyJavaScriptboolean

Determines if the JavaScript minifcation should be enabled

OptimizerWatermarkEnabledboolean

Determines if image watermarking should be enabled

OptimizerWatermarkUrlstring nullable

Sets the URL of the watermark image

OptimizerWatermarkPosition0 | 1 | 2 | 3 | 4 | 5

0 = BottomLeft 1 = BottomRight 2 = TopLeft 3 = TopRight 4 = Center 5 = CenterStretch

OptimizerWatermarkOffsetnumber double

Sets the offset of the watermark image

OptimizerWatermarkMinImageSizeinteger

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

OptimizerAutomaticOptimizationEnabledboolean

Determines if the automatic image optimization should be enabled

PermaCacheStorageZoneIdinteger

The IP of the storage zone used for Perma-Cache

PermaCacheType0 | 1

0 = Automatic 1 = Manual

OriginRetriesinteger

The number of retries to the origin server

OriginConnectTimeoutinteger

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

OriginResponseTimeoutinteger

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

UseStaleWhileUpdatingboolean

Determines if we should use stale cache while cache is updating

UseStaleWhileOfflineboolean

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

OriginRetry5XXResponsesboolean

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

OriginRetryConnectionTimeoutboolean

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

OriginRetryResponseTimeoutboolean

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

OriginRetryDelayinteger

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

QueryStringVaryParametersstring[] nullable

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

OriginShieldEnableConcurrencyLimitboolean

Determines if the origin shield concurrency limit is enabled.

OriginShieldMaxConcurrentRequestsinteger

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

EnableSafeHopboolean
CacheErrorResponsesboolean

Determines if bunny.net should be caching error responses

OriginShieldQueueMaxWaitTimeinteger

Determines the max queue wait time

OriginShieldMaxQueuedRequestsinteger

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

OptimizerForceClassesboolean

Determines if the optimizer class list should be enforced

OptimizerStaticHtmlEnabledboolean

Determines whether optimizer static html feature enabled

OptimizerStaticHtmlWordPressPathstring nullable

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

OptimizerStaticHtmlWordPressBypassCookiestring nullable

Wordpress cookie which should be bypassed by permacache in edge rule

UseBackgroundUpdateboolean

Determines if cache update is performed in the background.

EnableAutoSSLboolean

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

EnableQueryStringOrderingboolean

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

LogAnonymizationType0 | 1

0 = OneDigit 1 = Drop

LogFormat0 | 1

0 = Plain 1 = JSON

LogForwardingFormat0 | 1

0 = Plain 1 = JSON

ShieldDDosProtectionType0 | 1 | 2

0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive

ShieldDDosProtectionEnabledboolean
OriginType0 | 1 | 2 | 3 | 4 | 5 | 6

0 = OriginUrl 1 = DnsAccelerate 2 = StorageZone 3 = LoadBalancer 4 = EdgeScript 5 = MagicContainers 6 = PushZone

EnableRequestCoalescingboolean

Determines if request coalescing is currently enabled.

RequestCoalescingTimeoutinteger

Determines the lock time for coalesced requests.

OriginLinkValuestring nullable

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

DisableLetsEncryptboolean

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

EnableBunnyImageAiboolean
PreloadingScreenEnabledboolean

Determines if the preloading screen is currently enabled

PreloadingScreenShowOnFirstVisitboolean

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

PreloadingScreenCodestring nullable

The custom preloading screen code

PreloadingScreenLogoUrlstring nullable

The preloading screen logo URL

PreloadingScreenCodeEnabledboolean

Determines if the custom preloader screen is enabled

PreloadingScreenTheme0 | 1

0 = Light 1 = Dark

PreloadingScreenDelayinteger

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

EUUSDiscountinteger

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

SouthAmericaDiscountinteger

The Pull Zone specific pricing discount for South America region.

AfricaDiscountinteger

The Pull Zone specific pricing discount for Africa region.

AsiaOceaniaDiscountinteger

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

RoutingFiltersstring[] nullable

The list of routing filters enabled for this zone

BlockNoneReferrerboolean

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

StickySessionType0 | 1

0 = Off 1 = On

StickySessionCookieNamestring nullable

Sticky Session Cookie Name

StickySessionClientHeadersstring nullable

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

UserIdstring nullable

User Id of the pull zone owner

CacheVersioninteger
OptimizerEnableUpscalingboolean

Determines if Optimizer is allowed to upscale images

EnableWebSocketsboolean

Determines if WebSocket connections are allowed for this Pull Zone.

MaxWebSocketConnectionsinteger

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

EnableExtendedLoggingboolean

Determines if extended logging with additional details is enabled for this Pull Zone.

CacheKeyHeadersstring nullable

Vary Cache by Request Headers (comma delimited)