Skip to main content
GET
/
pullzone
/
{id}
Get Pull Zone
curl --request GET \
  --url https://api.bunny.net/pullzone/{id} \
  --header 'AccessKey: <api-key>'
{
  "Id": 123,
  "Name": "<string>",
  "OriginUrl": "<string>",
  "Enabled": true,
  "Suspended": true,
  "Hostnames": [
    {
      "Id": 123,
      "Value": "<string>",
      "ForceSSL": true,
      "IsSystemHostname": true,
      "IsManagedHostname": true,
      "HasCertificate": true,
      "Certificate": "<string>",
      "CertificateKey": "<string>",
      "CertificateKeyType": 0,
      "CertificateProvisionType": 0
    }
  ],
  "StorageZoneId": 123,
  "EdgeScriptId": 123,
  "EdgeScriptExecutionPhase": 0,
  "MiddlewareScriptId": 123,
  "MagicContainersAppId": "<string>",
  "MagicContainersEndpointId": "<string>",
  "AllowedReferrers": [
    "<string>"
  ],
  "BlockedReferrers": [
    "<string>"
  ],
  "BlockedIps": [
    "<string>"
  ],
  "EnableGeoZoneUS": true,
  "EnableGeoZoneEU": true,
  "EnableGeoZoneASIA": true,
  "EnableGeoZoneSA": true,
  "EnableGeoZoneAF": true,
  "ZoneSecurityEnabled": true,
  "ZoneSecurityKey": "<string>",
  "ZoneSecurityIncludeHashRemoteIP": true,
  "IgnoreQueryStrings": true,
  "MonthlyBandwidthLimit": 123,
  "MonthlyBandwidthUsed": 123,
  "MonthlyCharges": 123,
  "AddHostHeader": true,
  "OriginHostHeader": "<string>",
  "Type": 0,
  "AccessControlOriginHeaderExtensions": [
    "<string>"
  ],
  "EnableAccessControlOriginHeader": true,
  "DisableCookies": true,
  "BudgetRedirectedCountries": [
    "<string>"
  ],
  "BlockedCountries": [
    "<string>"
  ],
  "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,
  "EdgeRules": [
    {
      "Guid": "<string>",
      "ActionType": 0,
      "ActionParameter1": "<string>",
      "ActionParameter2": "<string>",
      "ActionParameter3": "<string>",
      "Triggers": [
        {
          "Type": 0,
          "PatternMatches": [
            "<string>"
          ],
          "PatternMatchingType": 0,
          "Parameter1": "<string>"
        }
      ],
      "ExtraActions": [
        {
          "ActionType": 0,
          "ActionParameter1": "<string>",
          "ActionParameter2": "<string>",
          "ActionParameter3": "<string>"
        }
      ],
      "TriggerMatchingType": 0,
      "Description": "<string>",
      "Enabled": true,
      "OrderIndex": 123,
      "ReadOnly": true
    }
  ],
  "EnableWebPVary": true,
  "EnableAvifVary": true,
  "EnableCountryCodeVary": true,
  "EnableCountryStateCodeVary": true,
  "EnableMobileVary": true,
  "EnableCookieVary": true,
  "CookieVaryParameters": [
    "<string>"
  ],
  "EnableHostnameVary": true,
  "CnameDomain": "<string>",
  "AWSSigningEnabled": true,
  "AWSSigningKey": "<string>",
  "AWSSigningSecret": "<string>",
  "AWSSigningRegionName": "<string>",
  "LoggingIPAnonymizationEnabled": true,
  "EnableTLS1": true,
  "EnableTLS1_1": true,
  "VerifyOriginSSL": true,
  "ErrorPageEnableCustomCode": true,
  "ErrorPageCustomCode": "<string>",
  "ErrorPageEnableStatuspageWidget": true,
  "ErrorPageStatuspageCode": "<string>",
  "ErrorPageWhitelabel": true,
  "OriginShieldZoneCode": "<string>",
  "LogForwardingEnabled": true,
  "LogForwardingHostname": "<string>",
  "LogForwardingPort": 123,
  "LogForwardingToken": "<string>",
  "LogForwardingProtocol": 0,
  "LoggingSaveToStorage": true,
  "LoggingStorageZoneId": 123,
  "FollowRedirects": true,
  "VideoLibraryId": 123,
  "DnsRecordId": 123,
  "DnsZoneId": 123,
  "DnsRecordValue": "<string>",
  "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": 0,
  "OptimizerWatermarkOffset": 123,
  "OptimizerWatermarkMinImageSize": 123,
  "OptimizerAutomaticOptimizationEnabled": true,
  "PermaCacheStorageZoneId": 123,
  "PermaCacheType": 0,
  "OriginRetries": 123,
  "OriginConnectTimeout": 123,
  "OriginResponseTimeout": 123,
  "UseStaleWhileUpdating": true,
  "UseStaleWhileOffline": true,
  "OriginRetry5XXResponses": true,
  "OriginRetryConnectionTimeout": true,
  "OriginRetryResponseTimeout": true,
  "OriginRetryDelay": 123,
  "QueryStringVaryParameters": [
    "<string>"
  ],
  "OriginShieldEnableConcurrencyLimit": true,
  "OriginShieldMaxConcurrentRequests": 123,
  "EnableSafeHop": true,
  "CacheErrorResponses": true,
  "OriginShieldQueueMaxWaitTime": 123,
  "OriginShieldMaxQueuedRequests": 123,
  "OptimizerClasses": [
    {
      "Name": "<string>",
      "Properties": {}
    }
  ],
  "OptimizerForceClasses": true,
  "OptimizerStaticHtmlEnabled": true,
  "OptimizerStaticHtmlWordPressPath": "<string>",
  "OptimizerStaticHtmlWordPressBypassCookie": "<string>",
  "UseBackgroundUpdate": true,
  "EnableAutoSSL": true,
  "EnableQueryStringOrdering": true,
  "LogAnonymizationType": 0,
  "LogFormat": 0,
  "LogForwardingFormat": 0,
  "ShieldDDosProtectionType": 0,
  "ShieldDDosProtectionEnabled": true,
  "OriginType": 0,
  "EnableRequestCoalescing": true,
  "RequestCoalescingTimeout": 123,
  "OriginLinkValue": "<string>",
  "DisableLetsEncrypt": true,
  "EnableBunnyImageAi": true,
  "BunnyAiImageBlueprints": [
    {
      "Name": "<string>",
      "Properties": {}
    }
  ],
  "PreloadingScreenEnabled": true,
  "PreloadingScreenShowOnFirstVisit": true,
  "PreloadingScreenCode": "<string>",
  "PreloadingScreenLogoUrl": "<string>",
  "PreloadingScreenCodeEnabled": true,
  "PreloadingScreenTheme": 0,
  "PreloadingScreenDelay": 123,
  "EUUSDiscount": 123,
  "SouthAmericaDiscount": 123,
  "AfricaDiscount": 123,
  "AsiaOceaniaDiscount": 123,
  "RoutingFilters": [
    "<string>"
  ],
  "BlockNoneReferrer": true,
  "StickySessionType": 0,
  "StickySessionCookieName": "<string>",
  "StickySessionClientHeaders": "<string>",
  "UserId": "<string>",
  "CacheVersion": 123,
  "OptimizerEnableUpscaling": true,
  "EnableWebSockets": true,
  "MaxWebSocketConnections": 123
}

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

Id
integer<int64>

The unique ID of the 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.

Enabled
boolean

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

Suspended
boolean
Hostnames
object[] | null

The list of hostnames linked to this Pull Zone

StorageZoneId
integer<int64>

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

EdgeScriptId
integer<int64>

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

EdgeScriptExecutionPhase
enum<integer>

The phase of the request where the script will be executed

Available options:
0,
1
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

EnableGeoZoneUS
boolean

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

EnableGeoZoneEU
boolean

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

EnableGeoZoneASIA
boolean

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

EnableGeoZoneSA
boolean

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

EnableGeoZoneAF
boolean

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

ZoneSecurityEnabled
boolean

True if the URL secure token authentication security is enabled

ZoneSecurityKey
string | null

The security key used for secure URL token authentication

ZoneSecurityIncludeHashRemoteIP
boolean

True if the zone security hash should include the remote IP

IgnoreQueryStrings
boolean

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

MonthlyBandwidthLimit
integer<int64>

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

MonthlyBandwidthUsed
integer<int64>

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

MonthlyCharges
number<decimal>

The total monthly charges for this so zone so far

AddHostHeader
boolean

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

OriginHostHeader
string | null

Determines the host header that will be sent to the origin

Type
enum<integer>

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

Available options:
0,
1
AccessControlOriginHeaderExtensions
string[] | null

The list of extensions that will return the CORS headers

EnableAccessControlOriginHeader
boolean

Determines if the CORS headers should be enabled

DisableCookies
boolean

Determines if the cookies are disabled for the pull zone

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

EnableOriginShield
boolean

If true the server will use the origin shield feature

CacheControlMaxAgeOverride
integer<int64>

The override cache time for the pull zone

CacheControlPublicMaxAgeOverride
integer<int64>

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

BurstSize
integer<int32>

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

RequestLimit
integer<int32>

Max number of requests per IP per second

BlockRootPathAccess
boolean

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

BlockPostRequests
boolean

If true, POST requests to the zone will be blocked

LimitRatePerSecond
number<double>

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

LimitRateAfter
number<double>

The amount of data after the rate limit will be activated

ConnectionLimitPerIPCount
integer<int32>

The number of connections limited per IP for this zone

PriceOverride
number<decimal>

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

OptimizerPricing
number<decimal>

Monthly pricing for Bunny Optimizer for this pull zone

AddCanonicalHeader
boolean

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

EnableLogging
boolean

Determines if the logging is enabled for this Pull Zone

EnableCacheSlice
boolean

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

EnableSmartCache
boolean

Determines if smart caching is enabled for this zone

EdgeRules
object[] | null

The list of edge rules on this Pull Zone

EnableWebPVary
boolean

Determines if the WebP Vary feature is enabled.

EnableAvifVary
boolean

Determines if the AVIF Vary feature is enabled.

EnableCountryCodeVary
boolean

Determines if the Country Code Vary feature is enabled.

EnableCountryStateCodeVary
boolean

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

EnableMobileVary
boolean

Determines if the Mobile Vary feature is enabled.

Determines if the Cookie Vary feature is enabled.

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

EnableHostnameVary
boolean

Determines if the Hostname Vary feature is enabled.

CnameDomain
string | null

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

AWSSigningEnabled
boolean

Determines if the AWS Signing is enabled

AWSSigningKey
string | null

The AWS Signing region key

AWSSigningSecret
string | null

The AWS Signing region secret

AWSSigningRegionName
string | null

The AWS Signing region name

LoggingIPAnonymizationEnabled
boolean

Determines if the TLS 1 is enabled on the Pull Zone

EnableTLS1
boolean

Determines if the TLS 1 is enabled on the Pull Zone

EnableTLS1_1
boolean

Determines if the TLS 1.1 is enabled on the Pull Zone

VerifyOriginSSL
boolean

Determines if the Pull Zone should verify the origin SSL certificate

ErrorPageEnableCustomCode
boolean

Determines if custom error page code should be enabled.

ErrorPageCustomCode
string | null

Contains the custom error page code that will be returned

ErrorPageEnableStatuspageWidget
boolean

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

Determines if the error pages should be whitelabel or not

OriginShieldZoneCode
string | null

The zone code of the origin shield

LogForwardingEnabled
boolean

Determines if the log forawrding is enabled

LogForwardingHostname
string | null

The log forwarding hostname

LogForwardingPort
integer<int32>

The log forwarding port

LogForwardingToken
string | null

The log forwarding token value

LogForwardingProtocol
enum<integer>

Determines the log forwarding protocol type

Available options:
0,
1,
2,
3
LoggingSaveToStorage
boolean

Determines if the permanent logging feature is enabled

LoggingStorageZoneId
integer<int64>

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

FollowRedirects
boolean

Determines if the zone will follow origin redirects

VideoLibraryId
integer<int64>

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

DnsRecordId
integer<int64>

The ID of the DNS record tied to this pull zone

DnsZoneId
integer<int64>

The ID of the DNS zone tied to this pull zone

DnsRecordValue
string | null

The cached version of the DNS record value

OptimizerEnabled
boolean

Determines if the optimizer should be enabled for this zone

OptimizerTunnelEnabled
boolean

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

OptimizerDesktopMaxWidth
integer<int32>

Determines the maximum automatic image size for desktop clients

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

Determines the maximum automatic image size for mobile clients

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

Determines the image quality for desktop clients

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

Determines the image quality for mobile clients

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

Determines if the WebP optimization should be enabled

OptimizerPrerenderHtml
boolean

Determines if the SEO HTML prerender is enabled

OptimizerEnableManipulationEngine
boolean

Determines the image manipulation should be enabled

OptimizerMinifyCSS
boolean

Determines if the CSS minifcation should be enabled

OptimizerMinifyJavaScript
boolean

Determines if the JavaScript minifcation should be enabled

OptimizerWatermarkEnabled
boolean

Determines if image watermarking should be enabled

OptimizerWatermarkUrl
string | null

Sets the URL of the watermark image

OptimizerWatermarkPosition
enum<integer>

Sets the position of the watermark image

Available options:
0,
1,
2,
3,
4,
5
OptimizerWatermarkOffset
number<double>

Sets the offset of the watermark image

OptimizerWatermarkMinImageSize
integer<int32>

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

OptimizerAutomaticOptimizationEnabled
boolean

Determines if the automatic image optimization should be enabled

PermaCacheStorageZoneId
integer<int64>

The IP of the storage zone used for Perma-Cache

PermaCacheType
enum<integer>

Determines Perma-Cache behavior

Available options:
0,
1
OriginRetries
integer<int32>

The number of retries to the origin server

OriginConnectTimeout
integer<int32>

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

OriginResponseTimeout
integer<int32>

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

UseStaleWhileUpdating
boolean

Determines if we should use stale cache while cache is updating

UseStaleWhileOffline
boolean

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

OriginRetry5XXResponses
boolean

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

OriginRetryConnectionTimeout
boolean

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

OriginRetryResponseTimeout
boolean

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

OriginRetryDelay
integer<int32>

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

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

OriginShieldEnableConcurrencyLimit
boolean

Determines if the origin shield concurrency limit is enabled.

OriginShieldMaxConcurrentRequests
integer<int32>

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

EnableSafeHop
boolean
CacheErrorResponses
boolean

Determines if bunny.net should be caching error responses

OriginShieldQueueMaxWaitTime
integer<int32>

Determines the max queue wait time

OriginShieldMaxQueuedRequests
integer<int32>

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

OptimizerClasses
object[] | null

Contains the list of optimizer classes

OptimizerForceClasses
boolean

Determines if the optimizer class list should be enforced

OptimizerStaticHtmlEnabled
boolean

Determines whether optimizer static html feature enabled

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

UseBackgroundUpdate
boolean

Determines if cache update is performed in the background.

EnableAutoSSL
boolean

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

EnableQueryStringOrdering
boolean

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

LogAnonymizationType
enum<integer>

Gets the log anonymization type for this pull zone

Available options:
0,
1
LogFormat
enum<integer>

0 = Plain 1 = JSON

Available options:
0,
1
LogForwardingFormat
enum<integer>

0 = Plain 1 = JSON

Available options:
0,
1
ShieldDDosProtectionType
enum<integer>

0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive

Available options:
0,
1,
2
ShieldDDosProtectionEnabled
boolean
OriginType
enum<integer>

The type of the origin for this Pull Zone

Available options:
0,
1,
2,
3,
4,
5,
6
EnableRequestCoalescing
boolean

Determines if request coalescing is currently enabled.

RequestCoalescingTimeout
integer<int32>

Determines the lock time for coalesced requests.

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

DisableLetsEncrypt
boolean

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

EnableBunnyImageAi
boolean
BunnyAiImageBlueprints
object[] | null
PreloadingScreenEnabled
boolean

Determines if the preloading screen is currently enabled

PreloadingScreenShowOnFirstVisit
boolean

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

PreloadingScreenCode
string | null

The custom preloading screen code

PreloadingScreenLogoUrl
string | null

The preloading screen logo URL

PreloadingScreenCodeEnabled
boolean

Determines if the custom preloader screen is enabled

PreloadingScreenTheme
enum<integer>

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

Available options:
0,
1
PreloadingScreenDelay
integer<int32>

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

EUUSDiscount
integer<int32>

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

SouthAmericaDiscount
integer<int32>

The Pull Zone specific pricing discount for South America region.

AfricaDiscount
integer<int32>

The Pull Zone specific pricing discount for Africa region.

AsiaOceaniaDiscount
integer<int32>

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

RoutingFilters
string[] | null

The list of routing filters enabled for this zone

BlockNoneReferrer
boolean

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

StickySessionType
enum<integer>

Whether to use a Sticky Session mechanism for this pull zone

Available options:
0,
1

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

CacheVersion
integer<int64>
OptimizerEnableUpscaling
boolean

Whether to automatically upscale assets when using Optimizer.

EnableWebSockets
boolean

Determines if WebSocket connections are allowed for this Pull Zone.

MaxWebSocketConnections
integer<int32>

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