Skip to main content
GET
/
pullzone
List Pull Zones
curl --request GET \
  --url https://api.bunny.net/pullzone \
  --header 'AccessKey: <api-key>'
{
  "CurrentPage": 123,
  "TotalItems": 123,
  "HasMoreItems": true,
  "Items": [
    {
      "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

Query Parameters

page
integer<int32>
default:0
perPage
integer<int32>
default:1000
Required range: 5 <= x <= 1000

The search term that will be used to filter the results

includeCertificate
boolean
default:false

Determines if the result hostnames should contain the SSL certificate

Response

The list of all the pull zones on the account

CurrentPage
integer<int32>
required
TotalItems
integer<int32>
required
HasMoreItems
boolean
required
Items
object[]