Skip to main content
Server path: /bunnycdn-cdn | Type: Application | PCID required: Yes

Tools

ToolDescription
bunnycdn_cdn_countries_public_get_country_listGet Country List
bunnycdn_cdn_pull_zone_public_addAdd Pull Zone
bunnycdn_cdn_pull_zone_public_add_allowed_referrerAdd Allowed Referer
bunnycdn_cdn_pull_zone_public_add_blocked_ipAdd Blocked IP
bunnycdn_cdn_pull_zone_public_add_blocked_referrerAdd Blocked Referer
bunnycdn_cdn_pull_zone_public_add_certificateAdd Custom Certificate
bunnycdn_cdn_pull_zone_public_add_edge_ruleAdd/Update Edge Rule
bunnycdn_cdn_pull_zone_public_add_hostnameAdd Custom Hostname
bunnycdn_cdn_pull_zone_public_check_availabilityCheck the pull zone availability
bunnycdn_cdn_pull_zone_public_complete_external_dns_certificateComplete External DNS Certificate
bunnycdn_cdn_pull_zone_public_deleteDelete Pull Zone
bunnycdn_cdn_pull_zone_public_delete_edge_ruleDelete Edge Rule
bunnycdn_cdn_pull_zone_public_indexGet Pull Zone
bunnycdn_cdn_pull_zone_public_index_allList Pull Zones
bunnycdn_cdn_pull_zone_public_load_free_certificateLoad Free Certificate
bunnycdn_cdn_pull_zone_public_optimizer_statisticsGet Optimizer Statistics
bunnycdn_cdn_pull_zone_public_origin_shield_concurrency_statisticsGet Origin Shield Queue Statistics
bunnycdn_cdn_pull_zone_public_purge_cache_post_by_tagPurge Cache
bunnycdn_cdn_pull_zone_public_remove_allowed_referrerRemove Allowed Referer
bunnycdn_cdn_pull_zone_public_remove_blocked_ipRemove Blocked IP
bunnycdn_cdn_pull_zone_public_remove_blocked_referrerRemove Blocked Referer
bunnycdn_cdn_pull_zone_public_remove_certificateRemove Certificate
bunnycdn_cdn_pull_zone_public_remove_hostnameRemove Custom Hostname
bunnycdn_cdn_pull_zone_public_request_external_dns_certificateRequest External DNS Certificate
bunnycdn_cdn_pull_zone_public_safe_hop_statisticsGet SafeHop Statistics
bunnycdn_cdn_pull_zone_public_set_edge_rule_enabledSet Edge Rule Enabled
bunnycdn_cdn_pull_zone_public_set_force_sslSet Force SSL
bunnycdn_cdn_pull_zone_public_update_private_key_typeChange hostname private key type
bunnycdn_cdn_pull_zone_public_update_pull_zoneUpdate Pull Zone
bunnycdn_cdn_purge_public_index_postPurge URL
bunnycdn_cdn_region_public_indexRegion list
bunnycdn_cdn_reset_security_key_endpoint_reset_security_keyReset Token Key

bunnycdn_cdn_countries_public_get_country_list

Get Country List

bunnycdn_cdn_pull_zone_public_add

Add Pull Zone Parameters:
ParameterTypeRequiredDefaultDescription
AccessControlOriginHeaderExtensionsstring[]NoSets the list of extensions that will return the CORS headers
AddCanonicalHeaderbooleanNoDetermines if the canonical header should be added by this zone
AddHostHeaderbooleanNoDetermines if the zone should forward the requested host header to the origin
AllowedReferrersstring[]NoSets 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
AWSSigningEnabledbooleanNoDetermines if the AWS signing should be enabled or not
AWSSigningKeystringNoSets the AWS signing key
AWSSigningRegionNamestringNoSets the AWS signing region name
AWSSigningSecretstringNoSets the AWS signing secret key
BlockedCountriesstring[]NoSets the list of two letter Alpha2 country codes that will be blocked from accessing the zone
BlockedIpsstring[]NoSets 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
BlockedReferrersstring[]NoSets the list of referrer hostnames that are blocked from accessing the pull zone.
BlockNoneReferrerbooleanNoBlock None Referrer
BlockPostRequestsbooleanNoDetermines if the POST requests to this zone should be rejected.
BlockRootPathAccessbooleanNoDetermines if the zone should block requests to the root of the zone.
BudgetRedirectedCountriesstring[]NoSets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region
BunnyAiImageBlueprintsobject[]NoBunny Ai Image Blueprints
BurstSizeintegerNoDetermines the maximum burst requests before an IP is blocked
CacheControlBrowserMaxAgeOverrideintegerNo(Deprecated) Sets the browser cache control override setting for this zone
CacheControlMaxAgeOverrideintegerNoSets the cache control override setting for this zone
CacheControlPublicMaxAgeOverrideintegerNoSets the browser cache control override setting for this zone
CacheErrorResponsesbooleanNoDetermines if the cache error responses should be enabled on the zone
ConnectionLimitPerIPCountintegerNoDetermines the maximum number of connections per IP that will be allowed to connect to this Pull Zone
CookieVaryParametersstring[]NoContains the list of vary parameters that will be used for vary cache by cookie string.Only alphanumeric characters, dashes and underscores are allowed (values that contain other characters are ignorred). If empty, cookie vary will not be used.
DisableCookiesbooleanNoDetermines if the Pull Zone should automatically remove cookies from the responses
DisableLetsEncryptbooleanNoIf set to true, the built-in let’s encrypt will be disabled and requests are passed to the origin.
DnsOriginPortintegerNoDetermines the origin port of the pull zone.
DnsOriginSchemestringNoDetermines the origin scheme of the pull zone.
EdgeScriptExecutionPhaseintegerNoThe execution phase of the edge script
EdgeScriptIdintegerNoThe ID of the edge script that will be used as the origin
EnableAccessControlOriginHeaderbooleanNoDetermines if CORS headers should be enabled
EnableAutoSSLbooleanNoIf set to true, any hostnames added to this Pull Zone will automatically enable SSL.
EnableAvifVarybooleanNoDetermines if the AVIF Vary feature should be enabled.
EnableBunnyImageAibooleanNoEnable Bunny Image Ai
EnableCacheSlicebooleanNoDetermines if cache slicing (Optimize for video) should be enabled for this zone
EnableCookieVarybooleanNoDetermines if the Cookie Vary feature is enabled.
EnableCountryCodeVarybooleanNoDetermines if the Country Code Vary feature should be enabled.
EnableCountryStateCodeVarybooleanNoDetermines if the Country State Code Vary feature should be enabled.
EnableGeoZoneAFbooleanNoDetermines if the delivery from the Africa region should be enabled for this pull zone
EnableGeoZoneASIAbooleanNoDetermines if the delivery from the Asia / Oceania regions should be enabled for this pull zone
EnableGeoZoneEUbooleanNoDetermines if the delivery from the Europe region should be enabled for this pull zone
EnableGeoZoneSAbooleanNoDetermines if the delivery from the South America region should be enabled for this pull zone
EnableGeoZoneUSbooleanNoDetermines if the delivery from the North America region should be enabled for this pull zone
EnableHostnameVarybooleanNoDetermines if the Hostname Vary feature should be enabled.
EnableLoggingbooleanNoDetermines if the logging should be enabled for this zone
EnableMobileVarybooleanNoDetermines if the Mobile Vary feature is enabled.
EnableOriginShieldbooleanNoDetermines if the origin shield should be enabled
EnableQueryStringOrderingbooleanNoDetermines if the query string ordering should be enabled.
EnableRequestCoalescingbooleanNoDetermines if request coalescing is currently enabled.
EnableSafeHopbooleanNoEnable Safe Hop
EnableSmartCachebooleanNoEnable Smart Cache
EnableTLS1booleanNoDetermines if the TLS 1 should be enabled on this zone
EnableTLS1_1booleanNoDetermines if the TLS 1.1 should be enabled on this zone
EnableWebpVarybooleanNoDetermines if the WebP Vary feature should be enabled.
EnableWebSocketsbooleanNoDetermines if WebSocket connections are allowed for this Pull Zone.
ErrorPageCustomCodestringNoContains the custom error page code that will be returned
ErrorPageEnableCustomCodebooleanNoDetermines if custom error page code should be enabled.
ErrorPageEnableStatuspageWidgetbooleanNoDetermines if the statuspage widget should be displayed on the error pages
ErrorPageStatuspageCodestringNoThe statuspage code that will be used to build the status widget
ErrorPageWhitelabelbooleanNoDetermines if the error pages should be whitelabel or not
FollowRedirectsbooleanNoDetermines if the zone should follow redirects return by the oprigin and cache the response
IgnoreQueryStringsbooleanNoDetermines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String)
LimitRateAfternumberNoDetermines the amount of traffic transferred before the client is limited
LimitRatePerSecondintegerNoDetermines the maximum number of requests per second coming from a single IP before it is blocked.
LogAnonymizationTypeintegerNoSets the log anonymization type for this pull zone
LogFormatintegerNo0 = Plain 1 = JSON
LogForwardingEnabledbooleanNoSets the log forwarding token for the zone
LogForwardingFormatintegerNo0 = Plain 1 = JSON
LogForwardingHostnamestringNoSets the log forwarding destination hostname for the zone
LogForwardingPortintegerNoSets the log forwarding port for the zone
LogForwardingProtocolintegerNoSets the log forwarding protocol type
LogForwardingTokenstringNoSets the log forwarding token for the zone
LoggingIPAnonymizationEnabledbooleanNoDetermines if the log anonoymization should be enabled
LoggingSaveToStoragebooleanNoDetermines if the logging permanent storage should be enabled
LoggingStorageZoneIdintegerNoSets the Storage Zone id that should contain the logs from this Pull Zone
MagicContainersAppIdstringNoMagic Containers App Id
MagicContainersEndpointIdstringNoMagic Containers Endpoint Id
MaxWebSocketConnectionsintegerNoThe maximum global simultaneous WebSocket connections allowed for this Pull Zone. Allowed tiers: 500, 1,000, 2,500, 5,000, 10,000, 25,000. If you send a non-tier value, the value is rounded up to the next tier. Values over 25,000 are rejected, please contact sales if required.
MiddlewareScriptIdintegerNoThe ID of the middleware script
MonthlyBandwidthLimitintegerNoSets the monthly limit of bandwidth in bytes that the pullzone is allowed to use
NamestringYesThe name of the pull zone.
OptimizerAutomaticOptimizationEnabledbooleanNoDetermines if the automatic image optimization should be enabled
OptimizerClassesobject[]NoDetermines the list of optimizer classes
OptimizerDesktopMaxWidthintegerNoDetermines the maximum automatic image size for desktop clients
OptimizerEnabledbooleanNoDetermines if the optimizer should be enabled for this zone
OptimizerEnableManipulationEnginebooleanNoDetermines the image manipulation should be enabled
OptimizerEnableUpscalingbooleanNoDetermines if Optimizer should automatically upscale images
OptimizerEnableWebPbooleanNoDetermines if the WebP optimization should be enabled
OptimizerForceClassesbooleanNoDetermines if the optimizer classes should be forced
OptimizerImageQualityintegerNoDetermines the image quality for desktop clients
OptimizerMinifyCSSbooleanNoDetermines if the CSS minifcation should be enabled
OptimizerMinifyJavaScriptbooleanNoDetermines if the JavaScript minifcation should be enabled
OptimizerMobileImageQualityintegerNoDetermines the image quality for mobile clients
OptimizerMobileMaxWidthintegerNoDetermines the maximum automatic image size for mobile clients
OptimizerPrerenderHtmlbooleanNoDetermines if the SEO HTML prerender should be enabled
OptimizerStaticHtmlEnabledbooleanNoDetermines whether optimizer static html feature enabled
OptimizerStaticHtmlWordPressBypassCookiestringNoWordpress cookie which should be bypassed by permacache in edge rule
OptimizerStaticHtmlWordPressPathstringNoWordpress html path which should be bypassed by permacache in edge rule
OptimizerTunnelEnabledbooleanNoDetermines if the optimizer origin tunnel system should be enabled for this zone
OptimizerWatermarkEnabledbooleanNoDetermines if image watermarking should be enabled
OptimizerWatermarkMinImageSizeintegerNoSets the minimum image size to which the watermark will be added
OptimizerWatermarkOffsetnumberNoSets the offset of the watermark image
OptimizerWatermarkPositionintegerNoSets the position of the watermark image
OptimizerWatermarkUrlstringNoSets the URL of the watermark image
OriginConnectTimeoutintegerNoThe amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry.
OriginHostHeaderstringNoSets the host header that will be sent to the origin
OriginResponseTimeoutintegerNoThe amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry.
OriginRetriesintegerNoThe number of retries to the origin server
OriginRetry5XXResponsesbooleanNoDetermines if we should retry the request in case of a 5XX response.
OriginRetryConnectionTimeoutbooleanNoDetermines if we should retry the request in case of a connection timeout.
OriginRetryDelayintegerNoDetermines the amount of time that the CDN should wait before retrying an origin request.
OriginRetryResponseTimeoutbooleanNoDetermines if we should retry the request in case of a response timeout.
OriginShieldEnableConcurrencyLimitbooleanNoDetermines if the origin shield concurrency limit is enabled.
OriginShieldMaxConcurrentRequestsintegerNoDetermines the number of maximum concurrent requests allowed to the origin.
OriginShieldMaxQueuedRequestsintegerNoDetermines the max number of origin requests that will remain in the queue
OriginShieldQueueMaxWaitTimeintegerNoDetermines the max queue wait time
OriginShieldZoneCodestringNoDetermines the zone code where the origin shield should be set up
OriginTypeintegerNoDetermine the type of the origin for this Pull Zone
OriginUrlstringNoSets the origin URL of the Pull Zone
PermaCacheStorageZoneIdintegerNoThe ID of the storage zone that should be used as the Perma-Cache
PermaCacheTypeintegerNoDetermines Perma-Cache behavior
PreloadingScreenCodestringNoThe custom preloading screen coed
PreloadingScreenCodeEnabledbooleanNoDetermines if the custom preloader screen should be enabled
PreloadingScreenDelayintegerNoThe delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms)
PreloadingScreenEnabledbooleanNoDetermines if the preloading screen is currently enabled
PreloadingScreenLogoUrlstringNoThe preloading screen logo URL
PreloadingScreenShowOnFirstVisitbooleanNoDetermines if the preloading screen is shown on the first load from a user.
PreloadingScreenThemeintegerNoThe currently configured preloading screem theme. (0 - Light, 1 - Dark)
QueryStringVaryParametersstring[]NoContains the list of vary parameters that will be used for vary cache by query string. Only alphanumeric characters, dashes and underscores are allowed (values that contain other characters are ignorred). If empty, all parameters will be used to construct the key.
RequestCoalescingTimeoutintegerNoDetermines the lock time for coalesced requests.
RequestLimitintegerNoDetermines the maximum number of requests per second that will be allowed to connect to this Pull Zone
RoutingFiltersstring[]NoThe list of routing filters enabled for this zone
ShieldDDosProtectionEnabledbooleanNoShield D Dos Protection Enabled
ShieldDDosProtectionTypeintegerNo0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive
StickySessionClientHeadersstringNoA set of comma-separated header names used to identify clients
StickySessionCookieNamestringNoSticky Session Cookie Name
StickySessionTypeintegerNoWhether to use a Sticky Session mechanism for this pull zone
StorageZoneIdintegerNoThe ID of the storage zone that will be used as the origin
TypeintegerNoThe type of the pull zone. Premium = 0, Volume = 1
UseBackgroundUpdatebooleanNoDetermines if cache update is performed in the background.
UseStaleWhileOfflinebooleanNoDetermines if we should use stale cache while the origin is offline
UseStaleWhileUpdatingbooleanNoDetermines if we should use stale cache while cache is updating
VerifyOriginSSLbooleanNoDetermines if the SSL certificate should be verified when connecting to the origin
ZoneSecurityEnabledbooleanNoDetermines if the zone token authentication security should be enabled
ZoneSecurityIncludeHashRemoteIPbooleanNoDetermines if the token authentication IP validation should be enabled

bunnycdn_cdn_pull_zone_public_add_allowed_referrer

Add Allowed Referer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname that will be added as an allowed referer

bunnycdn_cdn_pull_zone_public_add_blocked_ip

Add Blocked IP Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
BlockedIpstringYesThe IP that will be blocked from accessing the pull zone

bunnycdn_cdn_pull_zone_public_add_blocked_referrer

Add Blocked Referer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname that will be added as a blocked referer

bunnycdn_cdn_pull_zone_public_add_certificate

Add Custom Certificate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
CertificatestringYesThe Base64 encoded binary data of the certificate file
CertificateKeystringYesThe Base64 encoded binary data of the certificate key file
HostnamestringYesThe hostname to which the hostname will be added

bunnycdn_cdn_pull_zone_public_add_edge_rule

Add/Update Edge Rule Parameters:
ParameterTypeRequiredDefaultDescription
pullZoneIdintegerYesThe ID of the Pull Zone where the Edge Rule will be created
ActionParameter1stringNoThe Action parameter 1. The value depends on other parameters of the edge rule.
ActionParameter2stringNoThe Action parameter 2. The value depends on other parameters of the edge rule.
ActionParameter3stringNoThe Action parameter 3. The value depends on other parameters of the edge rule.
ActionTypeintegerNoThe action type of the edge rule. ForceSSL = 0, Redirect = 1, OriginUrl = 2, OverrideCacheTime = 3, BlockRequest = 4, SetResponseHeader = 5, SetRequestHeader = 6, ForceDownload = 7, DisableTokenAuthentication = 8, EnableTokenAuthentication = 9, OverrideCacheTimePublic = 10, IgnoreQueryString = 11, DisableOptimizer = 12, ForceCompression = 13, SetStatusCode = 14, BypassPermaCache = 15, OverrideBrowserCacheTime = 16
DescriptionstringNoThe description of the edge rule
EnabledbooleanNoDetermines if the edge rule is currently enabled or not
ExtraActionsobject[]NoExtra Actions
GuidstringNoThe unique GUID of the edge rule
OrderIndexintegerNoThe index of the edge rule in the list of execution priority
ReadOnlybooleanNoDetermines if the edge rule is read-only and cannot be modified or deleted
TriggerMatchingTypeintegerNoThe trigger matching type. MatchAny = 0, MatchAll = 1, MatchNone = 2
Triggersobject[]NoThe triggers value

bunnycdn_cdn_pull_zone_public_add_hostname

Add Custom Hostname Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname that will be added

bunnycdn_cdn_pull_zone_public_check_availability

Check the pull zone availability Parameters:
ParameterTypeRequiredDefaultDescription
NamestringNoDetermines the name of the zone that we are checking

bunnycdn_cdn_pull_zone_public_complete_external_dns_certificate

Complete External DNS Certificate Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesThe hostname that the certificate will be loaded for

bunnycdn_cdn_pull_zone_public_delete

Delete Pull Zone Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the Pull Zone that should be deleted

bunnycdn_cdn_pull_zone_public_delete_edge_rule

Delete Edge Rule Parameters:
ParameterTypeRequiredDefaultDescription
pullZoneIdintegerYesThe ID of the Pull Zone that contains the Edge Rule
edgeRuleIdstringYesThe ID of the Edge Rule that should be deleted

bunnycdn_cdn_pull_zone_public_index

Get Pull Zone Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the Pull Zone that should be returned
includeCertificatebooleanNoDetermines if the result hostnames should contain the SSL certificate

bunnycdn_cdn_pull_zone_public_index_all

List Pull Zones Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoThe page number to return. When set to 0 (default), all items are returned as a plain array. When set to a value greater than 0, items are returned in a paginated response object.
perPageintegerNoNumber of results per page
searchstringNoThe search term that will be used to filter the results
includeCertificatebooleanNoDetermines if the result hostnames should contain the SSL certificate

bunnycdn_cdn_pull_zone_public_load_free_certificate

Load Free Certificate Parameters:
ParameterTypeRequiredDefaultDescription
hostnamestringYesThe hostname that the certificate will be loaded for
useOnlyHttp01booleanNoIf false and a Bunny DNS Zone exists for the domain, DNS01 validation we be attempted. This has no effect on wildcard domains, as this can only use DNS01

bunnycdn_cdn_pull_zone_public_optimizer_statistics

Get Optimizer Statistics Parameters:
ParameterTypeRequiredDefaultDescription
pullZoneIdintegerYes(Optional) If set, the statistics will be only returned for the given Pull Zone
dateFromstringNo(Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned.
dateTostringNo(Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned.
hourlybooleanNo(Optional) If true, the statistics data will be returned in hourly groupping.

bunnycdn_cdn_pull_zone_public_origin_shield_concurrency_statistics

Get Origin Shield Queue Statistics Parameters:
ParameterTypeRequiredDefaultDescription
pullZoneIdintegerYes(Optional) If set, the statistics will be only returned for the given Pull Zone
dateFromstringNo(Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned.
dateTostringNo(Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned.
hourlybooleanNo(Optional) If true, the statistics data will be returned in hourly groupping.

bunnycdn_cdn_pull_zone_public_purge_cache_post_by_tag

Purge Cache Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the Pull Zone that should be cleared
CacheTagstringNoCache Tag

bunnycdn_cdn_pull_zone_public_remove_allowed_referrer

Remove Allowed Referer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname that will be removed as an allowed referer

bunnycdn_cdn_pull_zone_public_remove_blocked_ip

Remove Blocked IP Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
BlockedIpstringYesThe IP that will be removed fromt he block list

bunnycdn_cdn_pull_zone_public_remove_blocked_referrer

Remove Blocked Referer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname that will be removed as an allowed referer

bunnycdn_cdn_pull_zone_public_remove_certificate

Remove Certificate Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname from which the certificate will be removed

bunnycdn_cdn_pull_zone_public_remove_hostname

Remove Custom Hostname Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
HostnamestringYesThe hostname that will be removed

bunnycdn_cdn_pull_zone_public_request_external_dns_certificate

Request External DNS Certificate Parameters:
ParameterTypeRequiredDefaultDescription
bodystringYesThe hostname that the certificate will be requested for

bunnycdn_cdn_pull_zone_public_safe_hop_statistics

Get SafeHop Statistics Parameters:
ParameterTypeRequiredDefaultDescription
pullZoneIdintegerYes(Optional) If set, the statistics will be only returned for the given Pull Zone
dateFromstringNo(Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned.
dateTostringNo(Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned.
hourlybooleanNo(Optional) If true, the statistics data will be returned in hourly groupping.

bunnycdn_cdn_pull_zone_public_set_edge_rule_enabled

Set Edge Rule Enabled Parameters:
ParameterTypeRequiredDefaultDescription
pullZoneIdintegerYesThe ID of the Pull Zone that contains the Edge Rule
edgeRuleIdstringYesThe ID of the Edge Rule that should be updated
IdintegerNoThe id value
ValuebooleanNoThe value value

bunnycdn_cdn_pull_zone_public_set_force_ssl

Set Force SSL Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
ForceSSLbooleanYesSet to true to force SSL on the given pull zone hostname
HostnamestringYesThe hostname that will be updated

bunnycdn_cdn_pull_zone_public_update_private_key_type

Change hostname private key type Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe hostname that the private key type will be updated on
HostnamestringYesThe hostname value
KeyTypeintegerYes0 = Ecdsa 1 = Rsa

bunnycdn_cdn_pull_zone_public_update_pull_zone

Update Pull Zone Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the Pull Zone that should be updated
AccessControlOriginHeaderExtensionsstring[]NoSets the list of extensions that will return the CORS headers
AddCanonicalHeaderbooleanNoDetermines if the canonical header should be added by this zone
AddHostHeaderbooleanNoDetermines if the zone should forward the requested host header to the origin
AllowedReferrersstring[]NoSets 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
AWSSigningEnabledbooleanNoDetermines if the AWS signing should be enabled or not
AWSSigningKeystringNoSets the AWS signing key
AWSSigningRegionNamestringNoSets the AWS signing region name
AWSSigningSecretstringNoSets the AWS signing secret key
BlockedCountriesstring[]NoSets the list of two letter Alpha2 country codes that will be blocked from accessing the zone
BlockedIpsstring[]NoSets 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
BlockedReferrersstring[]NoSets the list of referrer hostnames that are blocked from accessing the pull zone.
BlockNoneReferrerbooleanNoBlock None Referrer
BlockPostRequestsbooleanNoDetermines if the POST requests to this zone should be rejected.
BlockRootPathAccessbooleanNoDetermines if the zone should block requests to the root of the zone.
BudgetRedirectedCountriesstring[]NoSets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region
BunnyAiImageBlueprintsobject[]NoBunny Ai Image Blueprints
BurstSizeintegerNoDetermines the maximum burst requests before an IP is blocked
CacheControlBrowserMaxAgeOverrideintegerNo(Deprecated) Sets the browser cache control override setting for this zone
CacheControlMaxAgeOverrideintegerNoSets the cache control override setting for this zone
CacheControlPublicMaxAgeOverrideintegerNoSets the browser cache control override setting for this zone
CacheErrorResponsesbooleanNoDetermines if the cache error responses should be enabled on the zone
ConnectionLimitPerIPCountintegerNoDetermines the maximum number of connections per IP that will be allowed to connect to this Pull Zone
CookieVaryParametersstring[]NoContains the list of vary parameters that will be used for vary cache by cookie string.Only alphanumeric characters, dashes and underscores are allowed (values that contain other characters are ignorred). If empty, cookie vary will not be used.
DisableCookiesbooleanNoDetermines if the Pull Zone should automatically remove cookies from the responses
DisableLetsEncryptbooleanNoIf set to true, the built-in let’s encrypt will be disabled and requests are passed to the origin.
DnsOriginPortintegerNoDetermines the origin port of the pull zone.
DnsOriginSchemestringNoDetermines the origin scheme of the pull zone.
EdgeScriptExecutionPhaseintegerNoThe execution phase of the edge script
EdgeScriptIdintegerNoThe ID of the edge script that will be used as the origin
EnableAccessControlOriginHeaderbooleanNoDetermines if CORS headers should be enabled
EnableAutoSSLbooleanNoIf set to true, any hostnames added to this Pull Zone will automatically enable SSL.
EnableAvifVarybooleanNoDetermines if the AVIF Vary feature should be enabled.
EnableBunnyImageAibooleanNoEnable Bunny Image Ai
EnableCacheSlicebooleanNoDetermines if cache slicing (Optimize for video) should be enabled for this zone
EnableCookieVarybooleanNoDetermines if the Cookie Vary feature is enabled.
EnableCountryCodeVarybooleanNoDetermines if the Country Code Vary feature should be enabled.
EnableCountryStateCodeVarybooleanNoDetermines if the Country State Code Vary feature should be enabled.
EnableGeoZoneAFbooleanNoDetermines if the delivery from the Africa region should be enabled for this pull zone
EnableGeoZoneASIAbooleanNoDetermines if the delivery from the Asia / Oceania regions should be enabled for this pull zone
EnableGeoZoneEUbooleanNoDetermines if the delivery from the Europe region should be enabled for this pull zone
EnableGeoZoneSAbooleanNoDetermines if the delivery from the South America region should be enabled for this pull zone
EnableGeoZoneUSbooleanNoDetermines if the delivery from the North America region should be enabled for this pull zone
EnableHostnameVarybooleanNoDetermines if the Hostname Vary feature should be enabled.
EnableLoggingbooleanNoDetermines if the logging should be enabled for this zone
EnableMobileVarybooleanNoDetermines if the Mobile Vary feature is enabled.
EnableOriginShieldbooleanNoDetermines if the origin shield should be enabled
EnableQueryStringOrderingbooleanNoDetermines if the query string ordering should be enabled.
EnableRequestCoalescingbooleanNoDetermines if request coalescing is currently enabled.
EnableSafeHopbooleanNoEnable Safe Hop
EnableSmartCachebooleanNoEnable Smart Cache
EnableTLS1booleanNoDetermines if the TLS 1 should be enabled on this zone
EnableTLS1_1booleanNoDetermines if the TLS 1.1 should be enabled on this zone
EnableWebpVarybooleanNoDetermines if the WebP Vary feature should be enabled.
EnableWebSocketsbooleanNoDetermines if WebSocket connections are allowed for this Pull Zone.
ErrorPageCustomCodestringNoContains the custom error page code that will be returned
ErrorPageEnableCustomCodebooleanNoDetermines if custom error page code should be enabled.
ErrorPageEnableStatuspageWidgetbooleanNoDetermines if the statuspage widget should be displayed on the error pages
ErrorPageStatuspageCodestringNoThe statuspage code that will be used to build the status widget
ErrorPageWhitelabelbooleanNoDetermines if the error pages should be whitelabel or not
FollowRedirectsbooleanNoDetermines if the zone should follow redirects return by the oprigin and cache the response
IgnoreQueryStringsbooleanNoDetermines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String)
LimitRateAfternumberNoDetermines the amount of traffic transferred before the client is limited
LimitRatePerSecondintegerNoDetermines the maximum number of requests per second coming from a single IP before it is blocked.
LogAnonymizationTypeintegerNoSets the log anonymization type for this pull zone
LogFormatintegerNo0 = Plain 1 = JSON
LogForwardingEnabledbooleanNoSets the log forwarding token for the zone
LogForwardingFormatintegerNo0 = Plain 1 = JSON
LogForwardingHostnamestringNoSets the log forwarding destination hostname for the zone
LogForwardingPortintegerNoSets the log forwarding port for the zone
LogForwardingProtocolintegerNoSets the log forwarding protocol type
LogForwardingTokenstringNoSets the log forwarding token for the zone
LoggingIPAnonymizationEnabledbooleanNoDetermines if the log anonoymization should be enabled
LoggingSaveToStoragebooleanNoDetermines if the logging permanent storage should be enabled
LoggingStorageZoneIdintegerNoSets the Storage Zone id that should contain the logs from this Pull Zone
MagicContainersAppIdstringNoMagic Containers App Id
MagicContainersEndpointIdstringNoMagic Containers Endpoint Id
MaxWebSocketConnectionsintegerNoThe maximum global simultaneous WebSocket connections allowed for this Pull Zone. Allowed tiers: 500, 1,000, 2,500, 5,000, 10,000, 25,000. If you send a non-tier value, the value is rounded up to the next tier. Values over 25,000 are rejected, please contact sales if required.
MiddlewareScriptIdintegerNoThe ID of the middleware script
MonthlyBandwidthLimitintegerNoSets the monthly limit of bandwidth in bytes that the pullzone is allowed to use
OptimizerAutomaticOptimizationEnabledbooleanNoDetermines if the automatic image optimization should be enabled
OptimizerClassesobject[]NoDetermines the list of optimizer classes
OptimizerDesktopMaxWidthintegerNoDetermines the maximum automatic image size for desktop clients
OptimizerEnabledbooleanNoDetermines if the optimizer should be enabled for this zone
OptimizerEnableManipulationEnginebooleanNoDetermines the image manipulation should be enabled
OptimizerEnableUpscalingbooleanNoDetermines if Optimizer should automatically upscale images
OptimizerEnableWebPbooleanNoDetermines if the WebP optimization should be enabled
OptimizerForceClassesbooleanNoDetermines if the optimizer classes should be forced
OptimizerImageQualityintegerNoDetermines the image quality for desktop clients
OptimizerMinifyCSSbooleanNoDetermines if the CSS minifcation should be enabled
OptimizerMinifyJavaScriptbooleanNoDetermines if the JavaScript minifcation should be enabled
OptimizerMobileImageQualityintegerNoDetermines the image quality for mobile clients
OptimizerMobileMaxWidthintegerNoDetermines the maximum automatic image size for mobile clients
OptimizerPrerenderHtmlbooleanNoDetermines if the SEO HTML prerender should be enabled
OptimizerStaticHtmlEnabledbooleanNoDetermines whether optimizer static html feature enabled
OptimizerStaticHtmlWordPressBypassCookiestringNoWordpress cookie which should be bypassed by permacache in edge rule
OptimizerStaticHtmlWordPressPathstringNoWordpress html path which should be bypassed by permacache in edge rule
OptimizerTunnelEnabledbooleanNoDetermines if the optimizer origin tunnel system should be enabled for this zone
OptimizerWatermarkEnabledbooleanNoDetermines if image watermarking should be enabled
OptimizerWatermarkMinImageSizeintegerNoSets the minimum image size to which the watermark will be added
OptimizerWatermarkOffsetnumberNoSets the offset of the watermark image
OptimizerWatermarkPositionintegerNoSets the position of the watermark image
OptimizerWatermarkUrlstringNoSets the URL of the watermark image
OriginConnectTimeoutintegerNoThe amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry.
OriginHostHeaderstringNoSets the host header that will be sent to the origin
OriginResponseTimeoutintegerNoThe amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry.
OriginRetriesintegerNoThe number of retries to the origin server
OriginRetry5XXResponsesbooleanNoDetermines if we should retry the request in case of a 5XX response.
OriginRetryConnectionTimeoutbooleanNoDetermines if we should retry the request in case of a connection timeout.
OriginRetryDelayintegerNoDetermines the amount of time that the CDN should wait before retrying an origin request.
OriginRetryResponseTimeoutbooleanNoDetermines if we should retry the request in case of a response timeout.
OriginShieldEnableConcurrencyLimitbooleanNoDetermines if the origin shield concurrency limit is enabled.
OriginShieldMaxConcurrentRequestsintegerNoDetermines the number of maximum concurrent requests allowed to the origin.
OriginShieldMaxQueuedRequestsintegerNoDetermines the max number of origin requests that will remain in the queue
OriginShieldQueueMaxWaitTimeintegerNoDetermines the max queue wait time
OriginShieldZoneCodestringNoDetermines the zone code where the origin shield should be set up
OriginTypeintegerNoDetermine the type of the origin for this Pull Zone
OriginUrlstringNoSets the origin URL of the Pull Zone
PermaCacheStorageZoneIdintegerNoThe ID of the storage zone that should be used as the Perma-Cache
PermaCacheTypeintegerNoDetermines Perma-Cache behavior
PreloadingScreenCodestringNoThe custom preloading screen coed
PreloadingScreenCodeEnabledbooleanNoDetermines if the custom preloader screen should be enabled
PreloadingScreenDelayintegerNoThe delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms)
PreloadingScreenEnabledbooleanNoDetermines if the preloading screen is currently enabled
PreloadingScreenLogoUrlstringNoThe preloading screen logo URL
PreloadingScreenShowOnFirstVisitbooleanNoDetermines if the preloading screen is shown on the first load from a user.
PreloadingScreenThemeintegerNoThe currently configured preloading screem theme. (0 - Light, 1 - Dark)
QueryStringVaryParametersstring[]NoContains the list of vary parameters that will be used for vary cache by query string. Only alphanumeric characters, dashes and underscores are allowed (values that contain other characters are ignorred). If empty, all parameters will be used to construct the key.
RequestCoalescingTimeoutintegerNoDetermines the lock time for coalesced requests.
RequestLimitintegerNoDetermines the maximum number of requests per second that will be allowed to connect to this Pull Zone
RoutingFiltersstring[]NoThe list of routing filters enabled for this zone
ShieldDDosProtectionEnabledbooleanNoShield D Dos Protection Enabled
ShieldDDosProtectionTypeintegerNo0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive
StickySessionClientHeadersstringNoA set of comma-separated header names used to identify clients
StickySessionCookieNamestringNoSticky Session Cookie Name
StickySessionTypeintegerNoWhether to use a Sticky Session mechanism for this pull zone
StorageZoneIdintegerNoThe ID of the storage zone that will be used as the origin
TypeintegerNoThe type of the pull zone. Premium = 0, Volume = 1
UseBackgroundUpdatebooleanNoDetermines if cache update is performed in the background.
UseStaleWhileOfflinebooleanNoDetermines if we should use stale cache while the origin is offline
UseStaleWhileUpdatingbooleanNoDetermines if we should use stale cache while cache is updating
VerifyOriginSSLbooleanNoDetermines if the SSL certificate should be verified when connecting to the origin
ZoneSecurityEnabledbooleanNoDetermines if the zone token authentication security should be enabled
ZoneSecurityIncludeHashRemoteIPbooleanNoDetermines if the token authentication IP validation should be enabled

bunnycdn_cdn_purge_public_index_post

Purge URL Parameters:
ParameterTypeRequiredDefaultDescription
urlstringYesThe URL that will be purged from cache.
asyncbooleanNo(Optional) Determines if the call should wait for the purge logic to complete
exactPathbooleanNo(Optional) When true and the URL ends with ’/’, purges only the exact path without adding a wildcard suffix. Only applies when the pull zone has IgnoreQueryStrings disabled.

bunnycdn_cdn_region_public_index

Region list

bunnycdn_cdn_reset_security_key_endpoint_reset_security_key

Reset Token Key Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the requested Pull Zone
SecurityKeystringNoSecurity Key