> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# bunnycdn-cdn
> BunnyCDN CDN - manage pull zones, purge cache, regions, and countries
**Server path:** `/bunnycdn-cdn` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| [`bunnycdn_cdn_countries_public_get_country_list`](#bunnycdn_cdn_countries_public_get_country_list) | Get Country List |
| [`bunnycdn_cdn_pull_zone_public_add`](#bunnycdn_cdn_pull_zone_public_add) | Add Pull Zone |
| [`bunnycdn_cdn_pull_zone_public_add_allowed_referrer`](#bunnycdn_cdn_pull_zone_public_add_allowed_referrer) | Add Allowed Referer |
| [`bunnycdn_cdn_pull_zone_public_add_blocked_ip`](#bunnycdn_cdn_pull_zone_public_add_blocked_ip) | Add Blocked IP |
| [`bunnycdn_cdn_pull_zone_public_add_blocked_referrer`](#bunnycdn_cdn_pull_zone_public_add_blocked_referrer) | Add Blocked Referer |
| [`bunnycdn_cdn_pull_zone_public_add_certificate`](#bunnycdn_cdn_pull_zone_public_add_certificate) | Add Custom Certificate |
| [`bunnycdn_cdn_pull_zone_public_add_edge_rule`](#bunnycdn_cdn_pull_zone_public_add_edge_rule) | Add/Update Edge Rule |
| [`bunnycdn_cdn_pull_zone_public_add_hostname`](#bunnycdn_cdn_pull_zone_public_add_hostname) | Add Custom Hostname |
| [`bunnycdn_cdn_pull_zone_public_check_availability`](#bunnycdn_cdn_pull_zone_public_check_availability) | Check the pull zone availability |
| [`bunnycdn_cdn_pull_zone_public_complete_external_dns_certificate`](#bunnycdn_cdn_pull_zone_public_complete_external_dns_certificate) | Complete External DNS Certificate |
| [`bunnycdn_cdn_pull_zone_public_delete`](#bunnycdn_cdn_pull_zone_public_delete) | Delete Pull Zone |
| [`bunnycdn_cdn_pull_zone_public_delete_edge_rule`](#bunnycdn_cdn_pull_zone_public_delete_edge_rule) | Delete Edge Rule |
| [`bunnycdn_cdn_pull_zone_public_index`](#bunnycdn_cdn_pull_zone_public_index) | Get Pull Zone |
| [`bunnycdn_cdn_pull_zone_public_index_all`](#bunnycdn_cdn_pull_zone_public_index_all) | List Pull Zones |
| [`bunnycdn_cdn_pull_zone_public_load_free_certificate`](#bunnycdn_cdn_pull_zone_public_load_free_certificate) | Load Free Certificate |
| [`bunnycdn_cdn_pull_zone_public_optimizer_statistics`](#bunnycdn_cdn_pull_zone_public_optimizer_statistics) | Get Optimizer Statistics |
| [`bunnycdn_cdn_pull_zone_public_origin_shield_concurrency_statistics`](#bunnycdn_cdn_pull_zone_public_origin_shield_concurrency_statistics) | Get Origin Shield Queue Statistics |
| [`bunnycdn_cdn_pull_zone_public_purge_cache_post_by_tag`](#bunnycdn_cdn_pull_zone_public_purge_cache_post_by_tag) | Purge Cache |
| [`bunnycdn_cdn_pull_zone_public_remove_allowed_referrer`](#bunnycdn_cdn_pull_zone_public_remove_allowed_referrer) | Remove Allowed Referer |
| [`bunnycdn_cdn_pull_zone_public_remove_blocked_ip`](#bunnycdn_cdn_pull_zone_public_remove_blocked_ip) | Remove Blocked IP |
| [`bunnycdn_cdn_pull_zone_public_remove_blocked_referrer`](#bunnycdn_cdn_pull_zone_public_remove_blocked_referrer) | Remove Blocked Referer |
| [`bunnycdn_cdn_pull_zone_public_remove_certificate`](#bunnycdn_cdn_pull_zone_public_remove_certificate) | Remove Certificate |
| [`bunnycdn_cdn_pull_zone_public_remove_hostname`](#bunnycdn_cdn_pull_zone_public_remove_hostname) | Remove Custom Hostname |
| [`bunnycdn_cdn_pull_zone_public_request_external_dns_certificate`](#bunnycdn_cdn_pull_zone_public_request_external_dns_certificate) | Request External DNS Certificate |
| [`bunnycdn_cdn_pull_zone_public_safe_hop_statistics`](#bunnycdn_cdn_pull_zone_public_safe_hop_statistics) | Get SafeHop Statistics |
| [`bunnycdn_cdn_pull_zone_public_set_edge_rule_enabled`](#bunnycdn_cdn_pull_zone_public_set_edge_rule_enabled) | Set Edge Rule Enabled |
| [`bunnycdn_cdn_pull_zone_public_set_force_ssl`](#bunnycdn_cdn_pull_zone_public_set_force_ssl) | Set Force SSL |
| [`bunnycdn_cdn_pull_zone_public_update_private_key_type`](#bunnycdn_cdn_pull_zone_public_update_private_key_type) | Change hostname private key type |
| [`bunnycdn_cdn_pull_zone_public_update_pull_zone`](#bunnycdn_cdn_pull_zone_public_update_pull_zone) | Update Pull Zone |
| [`bunnycdn_cdn_purge_public_index_post`](#bunnycdn_cdn_purge_public_index_post) | Purge URL |
| [`bunnycdn_cdn_region_public_index`](#bunnycdn_cdn_region_public_index) | Region list |
| [`bunnycdn_cdn_reset_security_key_endpoint_reset_security_key`](#bunnycdn_cdn_reset_security_key_endpoint_reset_security_key) | Reset Token Key |
***
## bunnycdn\_cdn\_countries\_public\_get\_country\_list
Get Country List
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add
Add Pull Zone
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `AccessControlOriginHeaderExtensions` | string\[] | No | — | Sets the list of extensions that will return the CORS headers | |
| `AddCanonicalHeader` | boolean | null | No | — | Determines if the canonical header should be added by this zone |
| `AddHostHeader` | boolean | null | No | — | Determines if the zone should forward the requested host header to the origin |
| `AllowedReferrers` | string\[] | No | — | Sets 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 | |
| `AWSSigningEnabled` | boolean | null | No | — | Determines if the AWS signing should be enabled or not |
| `AWSSigningKey` | string | null | No | — | Sets the AWS signing key |
| `AWSSigningRegionName` | string | null | No | — | Sets the AWS signing region name |
| `AWSSigningSecret` | string | null | No | — | Sets the AWS signing secret key |
| `BlockedCountries` | string\[] | No | — | Sets the list of two letter Alpha2 country codes that will be blocked from accessing the zone | |
| `BlockedIps` | string\[] | No | — | Sets 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 | |
| `BlockedReferrers` | string\[] | No | — | Sets the list of referrer hostnames that are blocked from accessing the pull zone. | |
| `BlockNoneReferrer` | boolean | null | No | — | Block None Referrer |
| `BlockPostRequests` | boolean | null | No | — | Determines if the POST requests to this zone should be rejected. |
| `BlockRootPathAccess` | boolean | null | No | — | Determines if the zone should block requests to the root of the zone. |
| `BudgetRedirectedCountries` | string\[] | No | — | Sets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region | |
| `BunnyAiImageBlueprints` | object\[] | No | — | Bunny Ai Image Blueprints | |
| `BurstSize` | integer | null | No | — | Determines the maximum burst requests before an IP is blocked |
| `CacheControlBrowserMaxAgeOverride` | integer | null | No | — | (Deprecated) Sets the browser cache control override setting for this zone |
| `CacheControlMaxAgeOverride` | integer | null | No | — | Sets the cache control override setting for this zone |
| `CacheControlPublicMaxAgeOverride` | integer | null | No | — | Sets the browser cache control override setting for this zone |
| `CacheErrorResponses` | boolean | null | No | — | Determines if the cache error responses should be enabled on the zone |
| `ConnectionLimitPerIPCount` | integer | null | No | — | Determines the maximum number of connections per IP that will be allowed to connect to this Pull Zone |
| `CookieVaryParameters` | string\[] | No | — | Contains 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. | |
| `DisableCookies` | boolean | null | No | — | Determines if the Pull Zone should automatically remove cookies from the responses |
| `DisableLetsEncrypt` | boolean | null | No | — | If set to true, the built-in let's encrypt will be disabled and requests are passed to the origin. |
| `DnsOriginPort` | integer | null | No | — | Determines the origin port of the pull zone. |
| `DnsOriginScheme` | string | null | No | — | Determines the origin scheme of the pull zone. |
| `EdgeScriptExecutionPhase` | integer | null | No | — | The execution phase of the edge script |
| `EdgeScriptId` | integer | null | No | — | The ID of the edge script that will be used as the origin |
| `EnableAccessControlOriginHeader` | boolean | null | No | — | Determines if CORS headers should be enabled |
| `EnableAutoSSL` | boolean | null | No | — | If set to true, any hostnames added to this Pull Zone will automatically enable SSL. |
| `EnableAvifVary` | boolean | null | No | — | Determines if the AVIF Vary feature should be enabled. |
| `EnableBunnyImageAi` | boolean | null | No | — | Enable Bunny Image Ai |
| `EnableCacheSlice` | boolean | null | No | — | Determines if cache slicing (Optimize for video) should be enabled for this zone |
| `EnableCookieVary` | boolean | null | No | — | Determines if the Cookie Vary feature is enabled. |
| `EnableCountryCodeVary` | boolean | null | No | — | Determines if the Country Code Vary feature should be enabled. |
| `EnableCountryStateCodeVary` | boolean | null | No | — | Determines if the Country State Code Vary feature should be enabled. |
| `EnableGeoZoneAF` | boolean | null | No | — | Determines if the delivery from the Africa region should be enabled for this pull zone |
| `EnableGeoZoneASIA` | boolean | null | No | — | Determines if the delivery from the Asia / Oceania regions should be enabled for this pull zone |
| `EnableGeoZoneEU` | boolean | null | No | — | Determines if the delivery from the Europe region should be enabled for this pull zone |
| `EnableGeoZoneSA` | boolean | null | No | — | Determines if the delivery from the South America region should be enabled for this pull zone |
| `EnableGeoZoneUS` | boolean | null | No | — | Determines if the delivery from the North America region should be enabled for this pull zone |
| `EnableHostnameVary` | boolean | null | No | — | Determines if the Hostname Vary feature should be enabled. |
| `EnableLogging` | boolean | null | No | — | Determines if the logging should be enabled for this zone |
| `EnableMobileVary` | boolean | null | No | — | Determines if the Mobile Vary feature is enabled. |
| `EnableOriginShield` | boolean | null | No | — | Determines if the origin shield should be enabled |
| `EnableQueryStringOrdering` | boolean | null | No | — | Determines if the query string ordering should be enabled. |
| `EnableRequestCoalescing` | boolean | null | No | — | Determines if request coalescing is currently enabled. |
| `EnableSafeHop` | boolean | null | No | — | Enable Safe Hop |
| `EnableSmartCache` | boolean | null | No | — | Enable Smart Cache |
| `EnableTLS1` | boolean | null | No | — | Determines if the TLS 1 should be enabled on this zone |
| `EnableTLS1_1` | boolean | null | No | — | Determines if the TLS 1.1 should be enabled on this zone |
| `EnableWebpVary` | boolean | null | No | — | Determines if the WebP Vary feature should be enabled. |
| `EnableWebSockets` | boolean | null | No | — | Determines if WebSocket connections are allowed for this Pull Zone. |
| `ErrorPageCustomCode` | string | null | No | — | Contains the custom error page code that will be returned |
| `ErrorPageEnableCustomCode` | boolean | null | No | — | Determines if custom error page code should be enabled. |
| `ErrorPageEnableStatuspageWidget` | boolean | null | No | — | Determines if the statuspage widget should be displayed on the error pages |
| `ErrorPageStatuspageCode` | string | null | No | — | The statuspage code that will be used to build the status widget |
| `ErrorPageWhitelabel` | boolean | null | No | — | Determines if the error pages should be whitelabel or not |
| `FollowRedirects` | boolean | null | No | — | Determines if the zone should follow redirects return by the oprigin and cache the response |
| `IgnoreQueryStrings` | boolean | null | No | — | Determines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String) |
| `LimitRateAfter` | number | null | No | — | Determines the amount of traffic transferred before the client is limited |
| `LimitRatePerSecond` | integer | null | No | — | Determines the maximum number of requests per second coming from a single IP before it is blocked. |
| `LogAnonymizationType` | integer | null | No | — | Sets the log anonymization type for this pull zone |
| `LogFormat` | integer | null | No | — | 0 = Plain 1 = JSON |
| `LogForwardingEnabled` | boolean | null | No | — | Sets the log forwarding token for the zone |
| `LogForwardingFormat` | integer | null | No | — | 0 = Plain 1 = JSON |
| `LogForwardingHostname` | string | null | No | — | Sets the log forwarding destination hostname for the zone |
| `LogForwardingPort` | integer | null | No | — | Sets the log forwarding port for the zone |
| `LogForwardingProtocol` | integer | null | No | — | Sets the log forwarding protocol type |
| `LogForwardingToken` | string | null | No | — | Sets the log forwarding token for the zone |
| `LoggingIPAnonymizationEnabled` | boolean | null | No | — | Determines if the log anonoymization should be enabled |
| `LoggingSaveToStorage` | boolean | null | No | — | Determines if the logging permanent storage should be enabled |
| `LoggingStorageZoneId` | integer | null | No | — | Sets the Storage Zone id that should contain the logs from this Pull Zone |
| `MagicContainersAppId` | string | null | No | — | Magic Containers App Id |
| `MagicContainersEndpointId` | string | null | No | — | Magic Containers Endpoint Id |
| `MaxWebSocketConnections` | integer | null | No | — | The 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. |
| `MiddlewareScriptId` | integer | null | No | — | The ID of the middleware script |
| `MonthlyBandwidthLimit` | integer | null | No | — | Sets the monthly limit of bandwidth in bytes that the pullzone is allowed to use |
| `Name` | string | Yes | — | The name of the pull zone. | |
| `OptimizerAutomaticOptimizationEnabled` | boolean | null | No | — | Determines if the automatic image optimization should be enabled |
| `OptimizerClasses` | object\[] | No | — | Determines the list of optimizer classes | |
| `OptimizerDesktopMaxWidth` | integer | null | No | — | Determines the maximum automatic image size for desktop clients |
| `OptimizerEnabled` | boolean | null | No | — | Determines if the optimizer should be enabled for this zone |
| `OptimizerEnableManipulationEngine` | boolean | null | No | — | Determines the image manipulation should be enabled |
| `OptimizerEnableUpscaling` | boolean | null | No | — | Determines if Optimizer should automatically upscale images |
| `OptimizerEnableWebP` | boolean | null | No | — | Determines if the WebP optimization should be enabled |
| `OptimizerForceClasses` | boolean | null | No | — | Determines if the optimizer classes should be forced |
| `OptimizerImageQuality` | integer | null | No | — | Determines the image quality for desktop clients |
| `OptimizerMinifyCSS` | boolean | null | No | — | Determines if the CSS minifcation should be enabled |
| `OptimizerMinifyJavaScript` | boolean | null | No | — | Determines if the JavaScript minifcation should be enabled |
| `OptimizerMobileImageQuality` | integer | null | No | — | Determines the image quality for mobile clients |
| `OptimizerMobileMaxWidth` | integer | null | No | — | Determines the maximum automatic image size for mobile clients |
| `OptimizerPrerenderHtml` | boolean | null | No | — | Determines if the SEO HTML prerender should be enabled |
| `OptimizerStaticHtmlEnabled` | boolean | null | No | — | Determines whether optimizer static html feature enabled |
| `OptimizerStaticHtmlWordPressBypassCookie` | string | null | No | — | Wordpress cookie which should be bypassed by permacache in edge rule |
| `OptimizerStaticHtmlWordPressPath` | string | null | No | — | Wordpress html path which should be bypassed by permacache in edge rule |
| `OptimizerTunnelEnabled` | boolean | null | No | — | Determines if the optimizer origin tunnel system should be enabled for this zone |
| `OptimizerWatermarkEnabled` | boolean | null | No | — | Determines if image watermarking should be enabled |
| `OptimizerWatermarkMinImageSize` | integer | null | No | — | Sets the minimum image size to which the watermark will be added |
| `OptimizerWatermarkOffset` | number | null | No | — | Sets the offset of the watermark image |
| `OptimizerWatermarkPosition` | integer | null | No | — | Sets the position of the watermark image |
| `OptimizerWatermarkUrl` | string | null | No | — | Sets the URL of the watermark image |
| `OriginConnectTimeout` | integer | null | No | — | The amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry. |
| `OriginHostHeader` | string | null | No | — | Sets the host header that will be sent to the origin |
| `OriginResponseTimeout` | integer | null | No | — | The amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry. |
| `OriginRetries` | integer | null | No | — | The number of retries to the origin server |
| `OriginRetry5XXResponses` | boolean | null | No | — | Determines if we should retry the request in case of a 5XX response. |
| `OriginRetryConnectionTimeout` | boolean | null | No | — | Determines if we should retry the request in case of a connection timeout. |
| `OriginRetryDelay` | integer | null | No | — | Determines the amount of time that the CDN should wait before retrying an origin request. |
| `OriginRetryResponseTimeout` | boolean | null | No | — | Determines if we should retry the request in case of a response timeout. |
| `OriginShieldEnableConcurrencyLimit` | boolean | null | No | — | Determines if the origin shield concurrency limit is enabled. |
| `OriginShieldMaxConcurrentRequests` | integer | null | No | — | Determines the number of maximum concurrent requests allowed to the origin. |
| `OriginShieldMaxQueuedRequests` | integer | null | No | — | Determines the max number of origin requests that will remain in the queue |
| `OriginShieldQueueMaxWaitTime` | integer | null | No | — | Determines the max queue wait time |
| `OriginShieldZoneCode` | string | null | No | — | Determines the zone code where the origin shield should be set up |
| `OriginType` | integer | null | No | — | Determine the type of the origin for this Pull Zone |
| `OriginUrl` | string | null | No | — | Sets the origin URL of the Pull Zone |
| `PermaCacheStorageZoneId` | integer | null | No | — | The ID of the storage zone that should be used as the Perma-Cache |
| `PermaCacheType` | integer | null | No | — | Determines Perma-Cache behavior |
| `PreloadingScreenCode` | string | null | No | — | The custom preloading screen coed |
| `PreloadingScreenCodeEnabled` | boolean | null | No | — | Determines if the custom preloader screen should be enabled |
| `PreloadingScreenDelay` | integer | null | No | — | The delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms) |
| `PreloadingScreenEnabled` | boolean | null | No | — | Determines if the preloading screen is currently enabled |
| `PreloadingScreenLogoUrl` | string | null | No | — | The preloading screen logo URL |
| `PreloadingScreenShowOnFirstVisit` | boolean | No | — | Determines if the preloading screen is shown on the first load from a user. | |
| `PreloadingScreenTheme` | integer | null | No | — | The currently configured preloading screem theme. (0 - Light, 1 - Dark) |
| `QueryStringVaryParameters` | string\[] | No | — | Contains 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. | |
| `RequestCoalescingTimeout` | integer | null | No | — | Determines the lock time for coalesced requests. |
| `RequestLimit` | integer | null | No | — | Determines the maximum number of requests per second that will be allowed to connect to this Pull Zone |
| `RoutingFilters` | string\[] | No | — | The list of routing filters enabled for this zone | |
| `ShieldDDosProtectionEnabled` | boolean | null | No | — | Shield D Dos Protection Enabled |
| `ShieldDDosProtectionType` | integer | null | No | — | 0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive |
| `StickySessionClientHeaders` | string | null | No | — | A set of comma-separated header names used to identify clients |
| `StickySessionCookieName` | string | null | No | — | Sticky Session Cookie Name |
| `StickySessionType` | integer | null | No | — | Whether to use a Sticky Session mechanism for this pull zone |
| `StorageZoneId` | integer | null | No | — | The ID of the storage zone that will be used as the origin |
| `Type` | integer | null | No | — | The type of the pull zone. Premium = 0, Volume = 1 |
| `UseBackgroundUpdate` | boolean | null | No | — | Determines if cache update is performed in the background. |
| `UseStaleWhileOffline` | boolean | null | No | — | Determines if we should use stale cache while the origin is offline |
| `UseStaleWhileUpdating` | boolean | null | No | — | Determines if we should use stale cache while cache is updating |
| `VerifyOriginSSL` | boolean | null | No | — | Determines if the SSL certificate should be verified when connecting to the origin |
| `ZoneSecurityEnabled` | boolean | null | No | — | Determines if the zone token authentication security should be enabled |
| `ZoneSecurityIncludeHashRemoteIP` | boolean | null | No | — | Determines if the token authentication IP validation should be enabled |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AccessControlOriginHeaderExtensions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of extensions that will return the CORS headers"
},
"AddCanonicalHeader": {
"type": [
"boolean",
"null"
],
"description": "Determines if the canonical header should be added by this zone"
},
"AddHostHeader": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone should forward the requested host header to the origin"
},
"AllowedReferrers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets 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"
},
"AWSSigningEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the AWS signing should be enabled or not"
},
"AWSSigningKey": {
"type": [
"string",
"null"
],
"description": "Sets the AWS signing key"
},
"AWSSigningRegionName": {
"type": [
"string",
"null"
],
"description": "Sets the AWS signing region name"
},
"AWSSigningSecret": {
"type": [
"string",
"null"
],
"description": "Sets the AWS signing secret key"
},
"BlockedCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of two letter Alpha2 country codes that will be blocked from accessing the zone"
},
"BlockedIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets 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"
},
"BlockedReferrers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of referrer hostnames that are blocked from accessing the pull zone."
},
"BlockNoneReferrer": {
"type": [
"boolean",
"null"
],
"description": "Block None Referrer"
},
"BlockPostRequests": {
"type": [
"boolean",
"null"
],
"description": "Determines if the POST requests to this zone should be rejected."
},
"BlockRootPathAccess": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone should block requests to the root of the zone."
},
"BudgetRedirectedCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region"
},
"BunnyAiImageBlueprints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The name value"
},
"Properties": {
"type": "object",
"description": "The properties value"
}
}
},
"description": "Bunny Ai Image Blueprints"
},
"BurstSize": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum burst requests before an IP is blocked"
},
"CacheControlBrowserMaxAgeOverride": {
"type": [
"integer",
"null"
],
"description": "(Deprecated) Sets the browser cache control override setting for this zone"
},
"CacheControlMaxAgeOverride": {
"type": [
"integer",
"null"
],
"description": "Sets the cache control override setting for this zone"
},
"CacheControlPublicMaxAgeOverride": {
"type": [
"integer",
"null"
],
"description": "Sets the browser cache control override setting for this zone"
},
"CacheErrorResponses": {
"type": [
"boolean",
"null"
],
"description": "Determines if the cache error responses should be enabled on the zone"
},
"ConnectionLimitPerIPCount": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum number of connections per IP that will be allowed to connect to this Pull Zone"
},
"CookieVaryParameters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contains 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."
},
"DisableCookies": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Pull Zone should automatically remove cookies from the responses"
},
"DisableLetsEncrypt": {
"type": [
"boolean",
"null"
],
"description": "If set to true, the built-in let's encrypt will be disabled and requests are passed to the origin."
},
"DnsOriginPort": {
"type": [
"integer",
"null"
],
"description": "Determines the origin port of the pull zone."
},
"DnsOriginScheme": {
"type": [
"string",
"null"
],
"description": "Determines the origin scheme of the pull zone."
},
"EdgeScriptExecutionPhase": {
"type": [
"integer",
"null"
],
"description": "The execution phase of the edge script",
"enum": [
0,
1
]
},
"EdgeScriptId": {
"type": [
"integer",
"null"
],
"description": "The ID of the edge script that will be used as the origin"
},
"EnableAccessControlOriginHeader": {
"type": [
"boolean",
"null"
],
"description": "Determines if CORS headers should be enabled"
},
"EnableAutoSSL": {
"type": [
"boolean",
"null"
],
"description": "If set to true, any hostnames added to this Pull Zone will automatically enable SSL."
},
"EnableAvifVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the AVIF Vary feature should be enabled."
},
"EnableBunnyImageAi": {
"type": [
"boolean",
"null"
],
"description": "Enable Bunny Image Ai"
},
"EnableCacheSlice": {
"type": [
"boolean",
"null"
],
"description": "Determines if cache slicing (Optimize for video) should be enabled for this zone"
},
"EnableCookieVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Cookie Vary feature is enabled."
},
"EnableCountryCodeVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Country Code Vary feature should be enabled."
},
"EnableCountryStateCodeVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Country State Code Vary feature should be enabled."
},
"EnableGeoZoneAF": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the Africa region should be enabled for this pull zone"
},
"EnableGeoZoneASIA": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the Asia / Oceania regions should be enabled for this pull zone"
},
"EnableGeoZoneEU": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the Europe region should be enabled for this pull zone"
},
"EnableGeoZoneSA": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the South America region should be enabled for this pull zone"
},
"EnableGeoZoneUS": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the North America region should be enabled for this pull zone"
},
"EnableHostnameVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Hostname Vary feature should be enabled."
},
"EnableLogging": {
"type": [
"boolean",
"null"
],
"description": "Determines if the logging should be enabled for this zone"
},
"EnableMobileVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Mobile Vary feature is enabled."
},
"EnableOriginShield": {
"type": [
"boolean",
"null"
],
"description": "Determines if the origin shield should be enabled"
},
"EnableQueryStringOrdering": {
"type": [
"boolean",
"null"
],
"description": "Determines if the query string ordering should be enabled."
},
"EnableRequestCoalescing": {
"type": [
"boolean",
"null"
],
"description": "Determines if request coalescing is currently enabled."
},
"EnableSafeHop": {
"type": [
"boolean",
"null"
],
"description": "Enable Safe Hop"
},
"EnableSmartCache": {
"type": [
"boolean",
"null"
],
"description": "Enable Smart Cache"
},
"EnableTLS1": {
"type": [
"boolean",
"null"
],
"description": "Determines if the TLS 1 should be enabled on this zone"
},
"EnableTLS1_1": {
"type": [
"boolean",
"null"
],
"description": "Determines if the TLS 1.1 should be enabled on this zone"
},
"EnableWebpVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the WebP Vary feature should be enabled."
},
"EnableWebSockets": {
"type": [
"boolean",
"null"
],
"description": "Determines if WebSocket connections are allowed for this Pull Zone."
},
"ErrorPageCustomCode": {
"type": [
"string",
"null"
],
"description": "Contains the custom error page code that will be returned"
},
"ErrorPageEnableCustomCode": {
"type": [
"boolean",
"null"
],
"description": "Determines if custom error page code should be enabled."
},
"ErrorPageEnableStatuspageWidget": {
"type": [
"boolean",
"null"
],
"description": "Determines if the statuspage widget should be displayed on the error pages"
},
"ErrorPageStatuspageCode": {
"type": [
"string",
"null"
],
"description": "The statuspage code that will be used to build the status widget"
},
"ErrorPageWhitelabel": {
"type": [
"boolean",
"null"
],
"description": "Determines if the error pages should be whitelabel or not"
},
"FollowRedirects": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone should follow redirects return by the oprigin and cache the response"
},
"IgnoreQueryStrings": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String)"
},
"LimitRateAfter": {
"type": [
"number",
"null"
],
"description": "Determines the amount of traffic transferred before the client is limited"
},
"LimitRatePerSecond": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum number of requests per second coming from a single IP before it is blocked."
},
"LogAnonymizationType": {
"type": [
"integer",
"null"
],
"description": "Sets the log anonymization type for this pull zone",
"enum": [
0,
1
]
},
"LogFormat": {
"type": [
"integer",
"null"
],
"description": "0 = Plain 1 = JSON",
"enum": [
0,
1
]
},
"LogForwardingEnabled": {
"type": [
"boolean",
"null"
],
"description": "Sets the log forwarding token for the zone"
},
"LogForwardingFormat": {
"type": [
"integer",
"null"
],
"description": "0 = Plain 1 = JSON",
"enum": [
0,
1
]
},
"LogForwardingHostname": {
"type": [
"string",
"null"
],
"description": "Sets the log forwarding destination hostname for the zone"
},
"LogForwardingPort": {
"type": [
"integer",
"null"
],
"description": "Sets the log forwarding port for the zone"
},
"LogForwardingProtocol": {
"type": [
"integer",
"null"
],
"description": "Sets the log forwarding protocol type",
"enum": [
0,
1,
2,
3
]
},
"LogForwardingToken": {
"type": [
"string",
"null"
],
"description": "Sets the log forwarding token for the zone"
},
"LoggingIPAnonymizationEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the log anonoymization should be enabled"
},
"LoggingSaveToStorage": {
"type": [
"boolean",
"null"
],
"description": "Determines if the logging permanent storage should be enabled"
},
"LoggingStorageZoneId": {
"type": [
"integer",
"null"
],
"description": "Sets the Storage Zone id that should contain the logs from this Pull Zone"
},
"MagicContainersAppId": {
"type": [
"string",
"null"
],
"description": "Magic Containers App Id"
},
"MagicContainersEndpointId": {
"type": [
"string",
"null"
],
"description": "Magic Containers Endpoint Id"
},
"MaxWebSocketConnections": {
"type": [
"integer",
"null"
],
"description": "The 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."
},
"MiddlewareScriptId": {
"type": [
"integer",
"null"
],
"description": "The ID of the middleware script"
},
"MonthlyBandwidthLimit": {
"type": [
"integer",
"null"
],
"description": "Sets the monthly limit of bandwidth in bytes that the pullzone is allowed to use"
},
"Name": {
"type": "string",
"description": "The name of the pull zone."
},
"OptimizerAutomaticOptimizationEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the automatic image optimization should be enabled"
},
"OptimizerClasses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The name of the optimizer class that will be used in the query string"
},
"Properties": {
"type": "object",
"description": "The list of settings and values the class will send to the optimizer"
}
}
},
"description": "Determines the list of optimizer classes"
},
"OptimizerDesktopMaxWidth": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum automatic image size for desktop clients"
},
"OptimizerEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the optimizer should be enabled for this zone"
},
"OptimizerEnableManipulationEngine": {
"type": [
"boolean",
"null"
],
"description": "Determines the image manipulation should be enabled"
},
"OptimizerEnableUpscaling": {
"type": [
"boolean",
"null"
],
"description": "Determines if Optimizer should automatically upscale images"
},
"OptimizerEnableWebP": {
"type": [
"boolean",
"null"
],
"description": "Determines if the WebP optimization should be enabled"
},
"OptimizerForceClasses": {
"type": [
"boolean",
"null"
],
"description": "Determines if the optimizer classes should be forced"
},
"OptimizerImageQuality": {
"type": [
"integer",
"null"
],
"description": "Determines the image quality for desktop clients"
},
"OptimizerMinifyCSS": {
"type": [
"boolean",
"null"
],
"description": "Determines if the CSS minifcation should be enabled"
},
"OptimizerMinifyJavaScript": {
"type": [
"boolean",
"null"
],
"description": "Determines if the JavaScript minifcation should be enabled"
},
"OptimizerMobileImageQuality": {
"type": [
"integer",
"null"
],
"description": "Determines the image quality for mobile clients"
},
"OptimizerMobileMaxWidth": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum automatic image size for mobile clients"
},
"OptimizerPrerenderHtml": {
"type": [
"boolean",
"null"
],
"description": "Determines if the SEO HTML prerender should be enabled"
},
"OptimizerStaticHtmlEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines whether optimizer static html feature enabled"
},
"OptimizerStaticHtmlWordPressBypassCookie": {
"type": [
"string",
"null"
],
"description": "Wordpress cookie which should be bypassed by permacache in edge rule"
},
"OptimizerStaticHtmlWordPressPath": {
"type": [
"string",
"null"
],
"description": "Wordpress html path which should be bypassed by permacache in edge rule"
},
"OptimizerTunnelEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the optimizer origin tunnel system should be enabled for this zone"
},
"OptimizerWatermarkEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if image watermarking should be enabled"
},
"OptimizerWatermarkMinImageSize": {
"type": [
"integer",
"null"
],
"description": "Sets the minimum image size to which the watermark will be added"
},
"OptimizerWatermarkOffset": {
"type": [
"number",
"null"
],
"description": "Sets the offset of the watermark image"
},
"OptimizerWatermarkPosition": {
"type": [
"integer",
"null"
],
"description": "Sets the position of the watermark image",
"enum": [
0,
1,
2,
3,
4,
5
]
},
"OptimizerWatermarkUrl": {
"type": [
"string",
"null"
],
"description": "Sets the URL of the watermark image"
},
"OriginConnectTimeout": {
"type": [
"integer",
"null"
],
"description": "The amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry."
},
"OriginHostHeader": {
"type": [
"string",
"null"
],
"description": "Sets the host header that will be sent to the origin"
},
"OriginResponseTimeout": {
"type": [
"integer",
"null"
],
"description": "The amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry."
},
"OriginRetries": {
"type": [
"integer",
"null"
],
"description": "The number of retries to the origin server"
},
"OriginRetry5XXResponses": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should retry the request in case of a 5XX response."
},
"OriginRetryConnectionTimeout": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should retry the request in case of a connection timeout."
},
"OriginRetryDelay": {
"type": [
"integer",
"null"
],
"description": "Determines the amount of time that the CDN should wait before retrying an origin request."
},
"OriginRetryResponseTimeout": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should retry the request in case of a response timeout."
},
"OriginShieldEnableConcurrencyLimit": {
"type": [
"boolean",
"null"
],
"description": "Determines if the origin shield concurrency limit is enabled."
},
"OriginShieldMaxConcurrentRequests": {
"type": [
"integer",
"null"
],
"description": "Determines the number of maximum concurrent requests allowed to the origin."
},
"OriginShieldMaxQueuedRequests": {
"type": [
"integer",
"null"
],
"description": "Determines the max number of origin requests that will remain in the queue"
},
"OriginShieldQueueMaxWaitTime": {
"type": [
"integer",
"null"
],
"description": "Determines the max queue wait time"
},
"OriginShieldZoneCode": {
"type": [
"string",
"null"
],
"description": "Determines the zone code where the origin shield should be set up"
},
"OriginType": {
"type": [
"integer",
"null"
],
"description": "Determine the type of the origin for this Pull Zone",
"enum": [
0,
1,
2,
3,
4,
5,
6
]
},
"OriginUrl": {
"type": [
"string",
"null"
],
"description": "Sets the origin URL of the Pull Zone"
},
"PermaCacheStorageZoneId": {
"type": [
"integer",
"null"
],
"description": "The ID of the storage zone that should be used as the Perma-Cache"
},
"PermaCacheType": {
"type": [
"integer",
"null"
],
"description": "Determines Perma-Cache behavior",
"enum": [
0,
1
]
},
"PreloadingScreenCode": {
"type": [
"string",
"null"
],
"description": "The custom preloading screen coed"
},
"PreloadingScreenCodeEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the custom preloader screen should be enabled"
},
"PreloadingScreenDelay": {
"type": [
"integer",
"null"
],
"description": "The delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms)"
},
"PreloadingScreenEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the preloading screen is currently enabled"
},
"PreloadingScreenLogoUrl": {
"type": [
"string",
"null"
],
"description": "The preloading screen logo URL"
},
"PreloadingScreenShowOnFirstVisit": {
"type": "boolean",
"description": "Determines if the preloading screen is shown on the first load from a user."
},
"PreloadingScreenTheme": {
"type": [
"integer",
"null"
],
"description": "The currently configured preloading screem theme. (0 - Light, 1 - Dark)",
"enum": [
0,
1
]
},
"QueryStringVaryParameters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contains 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."
},
"RequestCoalescingTimeout": {
"type": [
"integer",
"null"
],
"description": "Determines the lock time for coalesced requests."
},
"RequestLimit": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum number of requests per second that will be allowed to connect to this Pull Zone"
},
"RoutingFilters": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of routing filters enabled for this zone"
},
"ShieldDDosProtectionEnabled": {
"type": [
"boolean",
"null"
],
"description": "Shield D Dos Protection Enabled"
},
"ShieldDDosProtectionType": {
"type": [
"integer",
"null"
],
"description": "0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive",
"enum": [
0,
1,
2
]
},
"StickySessionClientHeaders": {
"type": [
"string",
"null"
],
"description": "A set of comma-separated header names used to identify clients"
},
"StickySessionCookieName": {
"type": [
"string",
"null"
],
"description": "Sticky Session Cookie Name"
},
"StickySessionType": {
"type": [
"integer",
"null"
],
"description": "Whether to use a Sticky Session mechanism for this pull zone",
"enum": [
0,
1
]
},
"StorageZoneId": {
"type": [
"integer",
"null"
],
"description": "The ID of the storage zone that will be used as the origin"
},
"Type": {
"type": [
"integer",
"null"
],
"description": "The type of the pull zone. Premium = 0, Volume = 1",
"enum": [
0,
1
]
},
"UseBackgroundUpdate": {
"type": [
"boolean",
"null"
],
"description": "Determines if cache update is performed in the background."
},
"UseStaleWhileOffline": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should use stale cache while the origin is offline"
},
"UseStaleWhileUpdating": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should use stale cache while cache is updating"
},
"VerifyOriginSSL": {
"type": [
"boolean",
"null"
],
"description": "Determines if the SSL certificate should be verified when connecting to the origin"
},
"ZoneSecurityEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone token authentication security should be enabled"
},
"ZoneSecurityIncludeHashRemoteIP": {
"type": [
"boolean",
"null"
],
"description": "Determines if the token authentication IP validation should be enabled"
}
},
"required": [
"PCID",
"Name"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add\_allowed\_referrer
Add Allowed Referer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ----------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname that will be added as an allowed referer |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be added as an allowed referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add\_blocked\_ip
Add Blocked IP
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | -------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `BlockedIp` | string | Yes | — | The IP that will be blocked from accessing the pull zone |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"BlockedIp": {
"type": "string",
"description": "The IP that will be blocked from accessing the pull zone"
}
},
"required": [
"PCID",
"id",
"BlockedIp"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add\_blocked\_referrer
Add Blocked Referer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ---------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname that will be added as a blocked referer |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be added as a blocked referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add\_certificate
Add Custom Certificate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ---------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Certificate` | string | Yes | — | The Base64 encoded binary data of the certificate file |
| `CertificateKey` | string | Yes | — | The Base64 encoded binary data of the certificate key file |
| `Hostname` | string | Yes | — | The hostname to which the hostname will be added |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Certificate": {
"type": "string",
"description": "The Base64 encoded binary data of the certificate file"
},
"CertificateKey": {
"type": "string",
"description": "The Base64 encoded binary data of the certificate key file"
},
"Hostname": {
"type": "string",
"description": "The hostname to which the hostname will be added"
}
},
"required": [
"PCID",
"id",
"Certificate",
"CertificateKey",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add\_edge\_rule
Add/Update Edge Rule
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `pullZoneId` | integer | Yes | — | The ID of the Pull Zone where the Edge Rule will be created | |
| `ActionParameter1` | string | null | No | — | The Action parameter 1. The value depends on other parameters of the edge rule. |
| `ActionParameter2` | string | null | No | — | The Action parameter 2. The value depends on other parameters of the edge rule. |
| `ActionParameter3` | string | null | No | — | The Action parameter 3. The value depends on other parameters of the edge rule. |
| `ActionType` | integer | No | — | The 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 | |
| `Description` | string | null | No | — | The description of the edge rule |
| `Enabled` | boolean | No | — | Determines if the edge rule is currently enabled or not | |
| `ExtraActions` | object\[] | No | — | Extra Actions | |
| `Guid` | string | null | No | — | The unique GUID of the edge rule |
| `OrderIndex` | integer | No | — | The index of the edge rule in the list of execution priority | |
| `ReadOnly` | boolean | No | — | Determines if the edge rule is read-only and cannot be modified or deleted | |
| `TriggerMatchingType` | integer | No | — | The trigger matching type. MatchAny = 0, MatchAll = 1, MatchNone = 2 | |
| `Triggers` | object\[] | No | — | The triggers value | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pullZoneId": {
"type": "integer",
"description": "The ID of the Pull Zone where the Edge Rule will be created"
},
"ActionParameter1": {
"type": [
"string",
"null"
],
"description": "The Action parameter 1. The value depends on other parameters of the edge rule."
},
"ActionParameter2": {
"type": [
"string",
"null"
],
"description": "The Action parameter 2. The value depends on other parameters of the edge rule."
},
"ActionParameter3": {
"type": [
"string",
"null"
],
"description": "The Action parameter 3. The value depends on other parameters of the edge rule."
},
"ActionType": {
"type": "integer",
"description": "The 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",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
]
},
"Description": {
"type": [
"string",
"null"
],
"description": "The description of the edge rule"
},
"Enabled": {
"type": "boolean",
"description": "Determines if the edge rule is currently enabled or not"
},
"ExtraActions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ActionType": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
31,
32,
33,
34
],
"description": "0 = ForceSSL 1 = Redirect 2 = OriginUrl 3 = OverrideCacheTime 4 = BlockRequest 5 = SetResponseHeader 6 = SetRequestHeader 7 = ForceDownload 8 = DisableTokenAuthentication 9 = EnableTokenAuthentication 10 = OverrideCacheTimePublic 11 = IgnoreQueryString 12 = DisableOptimizer 13 = ForceCompression 14 = SetStatusCode 15 = BypassPermaCache 16 = OverrideBrowserCacheTime 17 = OriginStorage 18 = SetNetworkRateLimit 19 = SetConnectionLimit 20 = SetRequestsPerSecondLimit 21 = RunEdgeScript 22 = OriginMagicContainers 23 = DisableWAF 24 = RetryOrigin 25 = OverrideBrowserCacheResponseHeader 26 = RemoveBrowserCacheResponseHeader 27 = DisableShieldChallenge 28 = DisableShield 29 = DisableShieldBotDetection 30 = BypassAwsS3Authentication 31 = DisableShieldAccessLists 32 = DisableShieldRateLimiting 33 = EnableRequestCoalescing 34 = DisableRequestCoalescing"
},
"ActionParameter1": {
"type": "string",
"description": "Action Parameter1"
},
"ActionParameter2": {
"type": "string",
"description": "Action Parameter2"
},
"ActionParameter3": {
"type": "string",
"description": "Action Parameter3"
}
}
},
"description": "Extra Actions"
},
"Guid": {
"type": [
"string",
"null"
],
"description": "The unique GUID of the edge rule"
},
"OrderIndex": {
"type": "integer",
"description": "The index of the edge rule in the list of execution priority"
},
"ReadOnly": {
"type": "boolean",
"description": "Determines if the edge rule is read-only and cannot be modified or deleted"
},
"TriggerMatchingType": {
"type": "integer",
"description": "The trigger matching type. MatchAny = 0, MatchAll = 1, MatchNone = 2",
"enum": [
0,
1,
2
]
},
"Triggers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Type": {
"type": "integer",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"description": "The type of the trigger. Url = 0, RequestHeader = 1, ResponseHeader = 2, UrlExtension = 3, CountryCode = 4, RemoteIP = 5, UrlQueryString = 6, RandomChance = 7"
},
"PatternMatches": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of pattern matches that will trigger the edge rule"
},
"PatternMatchingType": {
"type": "integer",
"enum": [
0,
1,
2
],
"description": "The type of pattern matching. MatchAny = 0, MatchAll = 1, MatchNone = 2"
},
"Parameter1": {
"type": "string",
"description": "The trigger parameter 1. The value depends on the type of trigger."
}
}
},
"description": "The triggers value"
}
},
"required": [
"PCID",
"pullZoneId"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_add\_hostname
Add Custom Hostname
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | --------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname that will be added |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be added"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_check\_availability
Check the pull zone availability
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------- | ------ | -------- | ------- | ----------- | ---------------------------------------------------- |
| `Name` | string | null | No | — | Determines the name of the zone that we are checking |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Name": {
"type": [
"string",
"null"
],
"description": "Determines the name of the zone that we are checking"
}
},
"required": [
"PCID"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_complete\_external\_dns\_certificate
Complete External DNS Certificate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `body` | string | Yes | — | The hostname that the certificate will be loaded for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "The hostname that the certificate will be loaded for"
}
},
"required": [
"PCID",
"body"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_delete
Delete Pull Zone
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ---------------------------------------------- |
| `id` | integer | Yes | — | The ID of the Pull Zone that should be deleted |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Pull Zone that should be deleted"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_delete\_edge\_rule
Delete Edge Rule
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------- |
| `pullZoneId` | integer | Yes | — | The ID of the Pull Zone that contains the Edge Rule |
| `edgeRuleId` | string | Yes | — | The ID of the Edge Rule that should be deleted |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pullZoneId": {
"type": "integer",
"description": "The ID of the Pull Zone that contains the Edge Rule"
},
"edgeRuleId": {
"type": "string",
"description": "The ID of the Edge Rule that should be deleted"
}
},
"required": [
"PCID",
"pullZoneId",
"edgeRuleId"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_index
Get Pull Zone
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the Pull Zone that should be returned |
| `includeCertificate` | boolean | No | — | Determines if the result hostnames should contain the SSL certificate |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Pull Zone that should be returned"
},
"includeCertificate": {
"type": "boolean",
"description": "Determines if the result hostnames should contain the SSL certificate"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_index\_all
List Pull Zones
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `page` | integer | No | — | The 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. |
| `perPage` | integer | No | — | Number of results per page |
| `search` | string | No | — | The search term that will be used to filter the results |
| `includeCertificate` | boolean | No | — | Determines if the result hostnames should contain the SSL certificate |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "The 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."
},
"perPage": {
"type": "integer",
"description": "Number of results per page"
},
"search": {
"type": "string",
"description": "The search term that will be used to filter the results"
},
"includeCertificate": {
"type": "boolean",
"description": "Determines if the result hostnames should contain the SSL certificate"
}
},
"required": [
"PCID"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_load\_free\_certificate
Load Free Certificate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `hostname` | string | Yes | — | The hostname that the certificate will be loaded for |
| `useOnlyHttp01` | boolean | No | — | If 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 |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"hostname": {
"type": "string",
"description": "The hostname that the certificate will be loaded for"
},
"useOnlyHttp01": {
"type": "boolean",
"description": "If 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"
}
},
"required": [
"PCID",
"hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_optimizer\_statistics
Get Optimizer Statistics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `pullZoneId` | integer | Yes | — | (Optional) If set, the statistics will be only returned for the given Pull Zone |
| `dateFrom` | string | No | — | (Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned. |
| `dateTo` | string | No | — | (Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned. |
| `hourly` | boolean | No | — | (Optional) If true, the statistics data will be returned in hourly groupping. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pullZoneId": {
"type": "integer",
"description": "(Optional) If set, the statistics will be only returned for the given Pull Zone"
},
"dateFrom": {
"type": "string",
"description": "(Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned."
},
"dateTo": {
"type": "string",
"description": "(Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned."
},
"hourly": {
"type": "boolean",
"description": "(Optional) If true, the statistics data will be returned in hourly groupping."
}
},
"required": [
"PCID",
"pullZoneId"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_origin\_shield\_concurrency\_statistics
Get Origin Shield Queue Statistics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `pullZoneId` | integer | Yes | — | (Optional) If set, the statistics will be only returned for the given Pull Zone |
| `dateFrom` | string | No | — | (Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned. |
| `dateTo` | string | No | — | (Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned. |
| `hourly` | boolean | No | — | (Optional) If true, the statistics data will be returned in hourly groupping. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pullZoneId": {
"type": "integer",
"description": "(Optional) If set, the statistics will be only returned for the given Pull Zone"
},
"dateFrom": {
"type": "string",
"description": "(Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned."
},
"dateTo": {
"type": "string",
"description": "(Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned."
},
"hourly": {
"type": "boolean",
"description": "(Optional) If true, the statistics data will be returned in hourly groupping."
}
},
"required": [
"PCID",
"pullZoneId"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_purge\_cache\_post\_by\_tag
Purge Cache
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ---------- | ------- | -------- | ------- | ---------------------------------------------- | --------- |
| `id` | integer | Yes | — | The ID of the Pull Zone that should be cleared | |
| `CacheTag` | string | null | No | — | Cache Tag |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Pull Zone that should be cleared"
},
"CacheTag": {
"type": [
"string",
"null"
],
"description": "Cache Tag"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_remove\_allowed\_referrer
Remove Allowed Referer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname that will be removed as an allowed referer |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be removed as an allowed referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_remove\_blocked\_ip
Remove Blocked IP
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `BlockedIp` | string | Yes | — | The IP that will be removed fromt he block list |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"BlockedIp": {
"type": "string",
"description": "The IP that will be removed fromt he block list"
}
},
"required": [
"PCID",
"id",
"BlockedIp"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_remove\_blocked\_referrer
Remove Blocked Referer
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname that will be removed as an allowed referer |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be removed as an allowed referer"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_remove\_certificate
Remove Certificate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname from which the certificate will be removed |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname from which the certificate will be removed"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_remove\_hostname
Remove Custom Hostname
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | --------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `Hostname` | string | Yes | — | The hostname that will be removed |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be removed"
}
},
"required": [
"PCID",
"id",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_request\_external\_dns\_certificate
Request External DNS Certificate
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------- |
| `body` | string | Yes | — | The hostname that the certificate will be requested for |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "The hostname that the certificate will be requested for"
}
},
"required": [
"PCID",
"body"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_safe\_hop\_statistics
Get SafeHop Statistics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `pullZoneId` | integer | Yes | — | (Optional) If set, the statistics will be only returned for the given Pull Zone |
| `dateFrom` | string | No | — | (Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned. |
| `dateTo` | string | No | — | (Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned. |
| `hourly` | boolean | No | — | (Optional) If true, the statistics data will be returned in hourly groupping. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pullZoneId": {
"type": "integer",
"description": "(Optional) If set, the statistics will be only returned for the given Pull Zone"
},
"dateFrom": {
"type": "string",
"description": "(Optional) The start date of the statistics. If no value is passed, the last 30 days will be returned."
},
"dateTo": {
"type": "string",
"description": "(Optional) The end date of the statistics. If no value is passed, the last 30 days will be returned."
},
"hourly": {
"type": "boolean",
"description": "(Optional) If true, the statistics data will be returned in hourly groupping."
}
},
"required": [
"PCID",
"pullZoneId"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_set\_edge\_rule\_enabled
Set Edge Rule Enabled
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | --------------------------------------------------- |
| `pullZoneId` | integer | Yes | — | The ID of the Pull Zone that contains the Edge Rule |
| `edgeRuleId` | string | Yes | — | The ID of the Edge Rule that should be updated |
| `Id` | integer | No | — | The id value |
| `Value` | boolean | No | — | The value value |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pullZoneId": {
"type": "integer",
"description": "The ID of the Pull Zone that contains the Edge Rule"
},
"edgeRuleId": {
"type": "string",
"description": "The ID of the Edge Rule that should be updated"
},
"Id": {
"type": "integer",
"description": "The id value"
},
"Value": {
"type": "boolean",
"description": "The value value"
}
},
"required": [
"PCID",
"pullZoneId",
"edgeRuleId"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_set\_force\_ssl
Set Force SSL
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | -------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the requested Pull Zone |
| `ForceSSL` | boolean | Yes | — | Set to true to force SSL on the given pull zone hostname |
| `Hostname` | string | Yes | — | The hostname that will be updated |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"ForceSSL": {
"type": "boolean",
"description": "Set to true to force SSL on the given pull zone hostname"
},
"Hostname": {
"type": "string",
"description": "The hostname that will be updated"
}
},
"required": [
"PCID",
"id",
"ForceSSL",
"Hostname"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_update\_private\_key\_type
Change hostname private key type
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------- | -------- | ------- | --------------------------------------------------------- |
| `id` | integer | Yes | — | The hostname that the private key type will be updated on |
| `Hostname` | string | Yes | — | The hostname value |
| `KeyType` | integer | Yes | — | 0 = Ecdsa 1 = Rsa |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The hostname that the private key type will be updated on"
},
"Hostname": {
"type": "string",
"description": "The hostname value"
},
"KeyType": {
"type": "integer",
"description": "0 = Ecdsa 1 = Rsa",
"enum": [
0,
1
]
}
},
"required": [
"PCID",
"id",
"Hostname",
"KeyType"
]
}
```
***
## bunnycdn\_cdn\_pull\_zone\_public\_update\_pull\_zone
Update Pull Zone
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------------------------------ | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the Pull Zone that should be updated | |
| `AccessControlOriginHeaderExtensions` | string\[] | No | — | Sets the list of extensions that will return the CORS headers | |
| `AddCanonicalHeader` | boolean | null | No | — | Determines if the canonical header should be added by this zone |
| `AddHostHeader` | boolean | null | No | — | Determines if the zone should forward the requested host header to the origin |
| `AllowedReferrers` | string\[] | No | — | Sets 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 | |
| `AWSSigningEnabled` | boolean | null | No | — | Determines if the AWS signing should be enabled or not |
| `AWSSigningKey` | string | null | No | — | Sets the AWS signing key |
| `AWSSigningRegionName` | string | null | No | — | Sets the AWS signing region name |
| `AWSSigningSecret` | string | null | No | — | Sets the AWS signing secret key |
| `BlockedCountries` | string\[] | No | — | Sets the list of two letter Alpha2 country codes that will be blocked from accessing the zone | |
| `BlockedIps` | string\[] | No | — | Sets 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 | |
| `BlockedReferrers` | string\[] | No | — | Sets the list of referrer hostnames that are blocked from accessing the pull zone. | |
| `BlockNoneReferrer` | boolean | null | No | — | Block None Referrer |
| `BlockPostRequests` | boolean | null | No | — | Determines if the POST requests to this zone should be rejected. |
| `BlockRootPathAccess` | boolean | null | No | — | Determines if the zone should block requests to the root of the zone. |
| `BudgetRedirectedCountries` | string\[] | No | — | Sets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region | |
| `BunnyAiImageBlueprints` | object\[] | No | — | Bunny Ai Image Blueprints | |
| `BurstSize` | integer | null | No | — | Determines the maximum burst requests before an IP is blocked |
| `CacheControlBrowserMaxAgeOverride` | integer | null | No | — | (Deprecated) Sets the browser cache control override setting for this zone |
| `CacheControlMaxAgeOverride` | integer | null | No | — | Sets the cache control override setting for this zone |
| `CacheControlPublicMaxAgeOverride` | integer | null | No | — | Sets the browser cache control override setting for this zone |
| `CacheErrorResponses` | boolean | null | No | — | Determines if the cache error responses should be enabled on the zone |
| `ConnectionLimitPerIPCount` | integer | null | No | — | Determines the maximum number of connections per IP that will be allowed to connect to this Pull Zone |
| `CookieVaryParameters` | string\[] | No | — | Contains 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. | |
| `DisableCookies` | boolean | null | No | — | Determines if the Pull Zone should automatically remove cookies from the responses |
| `DisableLetsEncrypt` | boolean | null | No | — | If set to true, the built-in let's encrypt will be disabled and requests are passed to the origin. |
| `DnsOriginPort` | integer | null | No | — | Determines the origin port of the pull zone. |
| `DnsOriginScheme` | string | null | No | — | Determines the origin scheme of the pull zone. |
| `EdgeScriptExecutionPhase` | integer | null | No | — | The execution phase of the edge script |
| `EdgeScriptId` | integer | null | No | — | The ID of the edge script that will be used as the origin |
| `EnableAccessControlOriginHeader` | boolean | null | No | — | Determines if CORS headers should be enabled |
| `EnableAutoSSL` | boolean | null | No | — | If set to true, any hostnames added to this Pull Zone will automatically enable SSL. |
| `EnableAvifVary` | boolean | null | No | — | Determines if the AVIF Vary feature should be enabled. |
| `EnableBunnyImageAi` | boolean | null | No | — | Enable Bunny Image Ai |
| `EnableCacheSlice` | boolean | null | No | — | Determines if cache slicing (Optimize for video) should be enabled for this zone |
| `EnableCookieVary` | boolean | null | No | — | Determines if the Cookie Vary feature is enabled. |
| `EnableCountryCodeVary` | boolean | null | No | — | Determines if the Country Code Vary feature should be enabled. |
| `EnableCountryStateCodeVary` | boolean | null | No | — | Determines if the Country State Code Vary feature should be enabled. |
| `EnableGeoZoneAF` | boolean | null | No | — | Determines if the delivery from the Africa region should be enabled for this pull zone |
| `EnableGeoZoneASIA` | boolean | null | No | — | Determines if the delivery from the Asia / Oceania regions should be enabled for this pull zone |
| `EnableGeoZoneEU` | boolean | null | No | — | Determines if the delivery from the Europe region should be enabled for this pull zone |
| `EnableGeoZoneSA` | boolean | null | No | — | Determines if the delivery from the South America region should be enabled for this pull zone |
| `EnableGeoZoneUS` | boolean | null | No | — | Determines if the delivery from the North America region should be enabled for this pull zone |
| `EnableHostnameVary` | boolean | null | No | — | Determines if the Hostname Vary feature should be enabled. |
| `EnableLogging` | boolean | null | No | — | Determines if the logging should be enabled for this zone |
| `EnableMobileVary` | boolean | null | No | — | Determines if the Mobile Vary feature is enabled. |
| `EnableOriginShield` | boolean | null | No | — | Determines if the origin shield should be enabled |
| `EnableQueryStringOrdering` | boolean | null | No | — | Determines if the query string ordering should be enabled. |
| `EnableRequestCoalescing` | boolean | null | No | — | Determines if request coalescing is currently enabled. |
| `EnableSafeHop` | boolean | null | No | — | Enable Safe Hop |
| `EnableSmartCache` | boolean | null | No | — | Enable Smart Cache |
| `EnableTLS1` | boolean | null | No | — | Determines if the TLS 1 should be enabled on this zone |
| `EnableTLS1_1` | boolean | null | No | — | Determines if the TLS 1.1 should be enabled on this zone |
| `EnableWebpVary` | boolean | null | No | — | Determines if the WebP Vary feature should be enabled. |
| `EnableWebSockets` | boolean | null | No | — | Determines if WebSocket connections are allowed for this Pull Zone. |
| `ErrorPageCustomCode` | string | null | No | — | Contains the custom error page code that will be returned |
| `ErrorPageEnableCustomCode` | boolean | null | No | — | Determines if custom error page code should be enabled. |
| `ErrorPageEnableStatuspageWidget` | boolean | null | No | — | Determines if the statuspage widget should be displayed on the error pages |
| `ErrorPageStatuspageCode` | string | null | No | — | The statuspage code that will be used to build the status widget |
| `ErrorPageWhitelabel` | boolean | null | No | — | Determines if the error pages should be whitelabel or not |
| `FollowRedirects` | boolean | null | No | — | Determines if the zone should follow redirects return by the oprigin and cache the response |
| `IgnoreQueryStrings` | boolean | null | No | — | Determines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String) |
| `LimitRateAfter` | number | null | No | — | Determines the amount of traffic transferred before the client is limited |
| `LimitRatePerSecond` | integer | null | No | — | Determines the maximum number of requests per second coming from a single IP before it is blocked. |
| `LogAnonymizationType` | integer | null | No | — | Sets the log anonymization type for this pull zone |
| `LogFormat` | integer | null | No | — | 0 = Plain 1 = JSON |
| `LogForwardingEnabled` | boolean | null | No | — | Sets the log forwarding token for the zone |
| `LogForwardingFormat` | integer | null | No | — | 0 = Plain 1 = JSON |
| `LogForwardingHostname` | string | null | No | — | Sets the log forwarding destination hostname for the zone |
| `LogForwardingPort` | integer | null | No | — | Sets the log forwarding port for the zone |
| `LogForwardingProtocol` | integer | null | No | — | Sets the log forwarding protocol type |
| `LogForwardingToken` | string | null | No | — | Sets the log forwarding token for the zone |
| `LoggingIPAnonymizationEnabled` | boolean | null | No | — | Determines if the log anonoymization should be enabled |
| `LoggingSaveToStorage` | boolean | null | No | — | Determines if the logging permanent storage should be enabled |
| `LoggingStorageZoneId` | integer | null | No | — | Sets the Storage Zone id that should contain the logs from this Pull Zone |
| `MagicContainersAppId` | string | null | No | — | Magic Containers App Id |
| `MagicContainersEndpointId` | string | null | No | — | Magic Containers Endpoint Id |
| `MaxWebSocketConnections` | integer | null | No | — | The 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. |
| `MiddlewareScriptId` | integer | null | No | — | The ID of the middleware script |
| `MonthlyBandwidthLimit` | integer | null | No | — | Sets the monthly limit of bandwidth in bytes that the pullzone is allowed to use |
| `OptimizerAutomaticOptimizationEnabled` | boolean | null | No | — | Determines if the automatic image optimization should be enabled |
| `OptimizerClasses` | object\[] | No | — | Determines the list of optimizer classes | |
| `OptimizerDesktopMaxWidth` | integer | null | No | — | Determines the maximum automatic image size for desktop clients |
| `OptimizerEnabled` | boolean | null | No | — | Determines if the optimizer should be enabled for this zone |
| `OptimizerEnableManipulationEngine` | boolean | null | No | — | Determines the image manipulation should be enabled |
| `OptimizerEnableUpscaling` | boolean | null | No | — | Determines if Optimizer should automatically upscale images |
| `OptimizerEnableWebP` | boolean | null | No | — | Determines if the WebP optimization should be enabled |
| `OptimizerForceClasses` | boolean | null | No | — | Determines if the optimizer classes should be forced |
| `OptimizerImageQuality` | integer | null | No | — | Determines the image quality for desktop clients |
| `OptimizerMinifyCSS` | boolean | null | No | — | Determines if the CSS minifcation should be enabled |
| `OptimizerMinifyJavaScript` | boolean | null | No | — | Determines if the JavaScript minifcation should be enabled |
| `OptimizerMobileImageQuality` | integer | null | No | — | Determines the image quality for mobile clients |
| `OptimizerMobileMaxWidth` | integer | null | No | — | Determines the maximum automatic image size for mobile clients |
| `OptimizerPrerenderHtml` | boolean | null | No | — | Determines if the SEO HTML prerender should be enabled |
| `OptimizerStaticHtmlEnabled` | boolean | null | No | — | Determines whether optimizer static html feature enabled |
| `OptimizerStaticHtmlWordPressBypassCookie` | string | null | No | — | Wordpress cookie which should be bypassed by permacache in edge rule |
| `OptimizerStaticHtmlWordPressPath` | string | null | No | — | Wordpress html path which should be bypassed by permacache in edge rule |
| `OptimizerTunnelEnabled` | boolean | null | No | — | Determines if the optimizer origin tunnel system should be enabled for this zone |
| `OptimizerWatermarkEnabled` | boolean | null | No | — | Determines if image watermarking should be enabled |
| `OptimizerWatermarkMinImageSize` | integer | null | No | — | Sets the minimum image size to which the watermark will be added |
| `OptimizerWatermarkOffset` | number | null | No | — | Sets the offset of the watermark image |
| `OptimizerWatermarkPosition` | integer | null | No | — | Sets the position of the watermark image |
| `OptimizerWatermarkUrl` | string | null | No | — | Sets the URL of the watermark image |
| `OriginConnectTimeout` | integer | null | No | — | The amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry. |
| `OriginHostHeader` | string | null | No | — | Sets the host header that will be sent to the origin |
| `OriginResponseTimeout` | integer | null | No | — | The amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry. |
| `OriginRetries` | integer | null | No | — | The number of retries to the origin server |
| `OriginRetry5XXResponses` | boolean | null | No | — | Determines if we should retry the request in case of a 5XX response. |
| `OriginRetryConnectionTimeout` | boolean | null | No | — | Determines if we should retry the request in case of a connection timeout. |
| `OriginRetryDelay` | integer | null | No | — | Determines the amount of time that the CDN should wait before retrying an origin request. |
| `OriginRetryResponseTimeout` | boolean | null | No | — | Determines if we should retry the request in case of a response timeout. |
| `OriginShieldEnableConcurrencyLimit` | boolean | null | No | — | Determines if the origin shield concurrency limit is enabled. |
| `OriginShieldMaxConcurrentRequests` | integer | null | No | — | Determines the number of maximum concurrent requests allowed to the origin. |
| `OriginShieldMaxQueuedRequests` | integer | null | No | — | Determines the max number of origin requests that will remain in the queue |
| `OriginShieldQueueMaxWaitTime` | integer | null | No | — | Determines the max queue wait time |
| `OriginShieldZoneCode` | string | null | No | — | Determines the zone code where the origin shield should be set up |
| `OriginType` | integer | null | No | — | Determine the type of the origin for this Pull Zone |
| `OriginUrl` | string | null | No | — | Sets the origin URL of the Pull Zone |
| `PermaCacheStorageZoneId` | integer | null | No | — | The ID of the storage zone that should be used as the Perma-Cache |
| `PermaCacheType` | integer | null | No | — | Determines Perma-Cache behavior |
| `PreloadingScreenCode` | string | null | No | — | The custom preloading screen coed |
| `PreloadingScreenCodeEnabled` | boolean | null | No | — | Determines if the custom preloader screen should be enabled |
| `PreloadingScreenDelay` | integer | null | No | — | The delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms) |
| `PreloadingScreenEnabled` | boolean | null | No | — | Determines if the preloading screen is currently enabled |
| `PreloadingScreenLogoUrl` | string | null | No | — | The preloading screen logo URL |
| `PreloadingScreenShowOnFirstVisit` | boolean | No | — | Determines if the preloading screen is shown on the first load from a user. | |
| `PreloadingScreenTheme` | integer | null | No | — | The currently configured preloading screem theme. (0 - Light, 1 - Dark) |
| `QueryStringVaryParameters` | string\[] | No | — | Contains 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. | |
| `RequestCoalescingTimeout` | integer | null | No | — | Determines the lock time for coalesced requests. |
| `RequestLimit` | integer | null | No | — | Determines the maximum number of requests per second that will be allowed to connect to this Pull Zone |
| `RoutingFilters` | string\[] | No | — | The list of routing filters enabled for this zone | |
| `ShieldDDosProtectionEnabled` | boolean | null | No | — | Shield D Dos Protection Enabled |
| `ShieldDDosProtectionType` | integer | null | No | — | 0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive |
| `StickySessionClientHeaders` | string | null | No | — | A set of comma-separated header names used to identify clients |
| `StickySessionCookieName` | string | null | No | — | Sticky Session Cookie Name |
| `StickySessionType` | integer | null | No | — | Whether to use a Sticky Session mechanism for this pull zone |
| `StorageZoneId` | integer | null | No | — | The ID of the storage zone that will be used as the origin |
| `Type` | integer | null | No | — | The type of the pull zone. Premium = 0, Volume = 1 |
| `UseBackgroundUpdate` | boolean | null | No | — | Determines if cache update is performed in the background. |
| `UseStaleWhileOffline` | boolean | null | No | — | Determines if we should use stale cache while the origin is offline |
| `UseStaleWhileUpdating` | boolean | null | No | — | Determines if we should use stale cache while cache is updating |
| `VerifyOriginSSL` | boolean | null | No | — | Determines if the SSL certificate should be verified when connecting to the origin |
| `ZoneSecurityEnabled` | boolean | null | No | — | Determines if the zone token authentication security should be enabled |
| `ZoneSecurityIncludeHashRemoteIP` | boolean | null | No | — | Determines if the token authentication IP validation should be enabled |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the Pull Zone that should be updated"
},
"AccessControlOriginHeaderExtensions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of extensions that will return the CORS headers"
},
"AddCanonicalHeader": {
"type": [
"boolean",
"null"
],
"description": "Determines if the canonical header should be added by this zone"
},
"AddHostHeader": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone should forward the requested host header to the origin"
},
"AllowedReferrers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets 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"
},
"AWSSigningEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the AWS signing should be enabled or not"
},
"AWSSigningKey": {
"type": [
"string",
"null"
],
"description": "Sets the AWS signing key"
},
"AWSSigningRegionName": {
"type": [
"string",
"null"
],
"description": "Sets the AWS signing region name"
},
"AWSSigningSecret": {
"type": [
"string",
"null"
],
"description": "Sets the AWS signing secret key"
},
"BlockedCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of two letter Alpha2 country codes that will be blocked from accessing the zone"
},
"BlockedIps": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets 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"
},
"BlockedReferrers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of referrer hostnames that are blocked from accessing the pull zone."
},
"BlockNoneReferrer": {
"type": [
"boolean",
"null"
],
"description": "Block None Referrer"
},
"BlockPostRequests": {
"type": [
"boolean",
"null"
],
"description": "Determines if the POST requests to this zone should be rejected."
},
"BlockRootPathAccess": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone should block requests to the root of the zone."
},
"BudgetRedirectedCountries": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sets the list of two letter Alpha2 country codes that will be redirected to the cheapest possible region"
},
"BunnyAiImageBlueprints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The name value"
},
"Properties": {
"type": "object",
"description": "The properties value"
}
}
},
"description": "Bunny Ai Image Blueprints"
},
"BurstSize": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum burst requests before an IP is blocked"
},
"CacheControlBrowserMaxAgeOverride": {
"type": [
"integer",
"null"
],
"description": "(Deprecated) Sets the browser cache control override setting for this zone"
},
"CacheControlMaxAgeOverride": {
"type": [
"integer",
"null"
],
"description": "Sets the cache control override setting for this zone"
},
"CacheControlPublicMaxAgeOverride": {
"type": [
"integer",
"null"
],
"description": "Sets the browser cache control override setting for this zone"
},
"CacheErrorResponses": {
"type": [
"boolean",
"null"
],
"description": "Determines if the cache error responses should be enabled on the zone"
},
"ConnectionLimitPerIPCount": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum number of connections per IP that will be allowed to connect to this Pull Zone"
},
"CookieVaryParameters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contains 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."
},
"DisableCookies": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Pull Zone should automatically remove cookies from the responses"
},
"DisableLetsEncrypt": {
"type": [
"boolean",
"null"
],
"description": "If set to true, the built-in let's encrypt will be disabled and requests are passed to the origin."
},
"DnsOriginPort": {
"type": [
"integer",
"null"
],
"description": "Determines the origin port of the pull zone."
},
"DnsOriginScheme": {
"type": [
"string",
"null"
],
"description": "Determines the origin scheme of the pull zone."
},
"EdgeScriptExecutionPhase": {
"type": [
"integer",
"null"
],
"description": "The execution phase of the edge script",
"enum": [
0,
1
]
},
"EdgeScriptId": {
"type": [
"integer",
"null"
],
"description": "The ID of the edge script that will be used as the origin"
},
"EnableAccessControlOriginHeader": {
"type": [
"boolean",
"null"
],
"description": "Determines if CORS headers should be enabled"
},
"EnableAutoSSL": {
"type": [
"boolean",
"null"
],
"description": "If set to true, any hostnames added to this Pull Zone will automatically enable SSL."
},
"EnableAvifVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the AVIF Vary feature should be enabled."
},
"EnableBunnyImageAi": {
"type": [
"boolean",
"null"
],
"description": "Enable Bunny Image Ai"
},
"EnableCacheSlice": {
"type": [
"boolean",
"null"
],
"description": "Determines if cache slicing (Optimize for video) should be enabled for this zone"
},
"EnableCookieVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Cookie Vary feature is enabled."
},
"EnableCountryCodeVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Country Code Vary feature should be enabled."
},
"EnableCountryStateCodeVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Country State Code Vary feature should be enabled."
},
"EnableGeoZoneAF": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the Africa region should be enabled for this pull zone"
},
"EnableGeoZoneASIA": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the Asia / Oceania regions should be enabled for this pull zone"
},
"EnableGeoZoneEU": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the Europe region should be enabled for this pull zone"
},
"EnableGeoZoneSA": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the South America region should be enabled for this pull zone"
},
"EnableGeoZoneUS": {
"type": [
"boolean",
"null"
],
"description": "Determines if the delivery from the North America region should be enabled for this pull zone"
},
"EnableHostnameVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Hostname Vary feature should be enabled."
},
"EnableLogging": {
"type": [
"boolean",
"null"
],
"description": "Determines if the logging should be enabled for this zone"
},
"EnableMobileVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Mobile Vary feature is enabled."
},
"EnableOriginShield": {
"type": [
"boolean",
"null"
],
"description": "Determines if the origin shield should be enabled"
},
"EnableQueryStringOrdering": {
"type": [
"boolean",
"null"
],
"description": "Determines if the query string ordering should be enabled."
},
"EnableRequestCoalescing": {
"type": [
"boolean",
"null"
],
"description": "Determines if request coalescing is currently enabled."
},
"EnableSafeHop": {
"type": [
"boolean",
"null"
],
"description": "Enable Safe Hop"
},
"EnableSmartCache": {
"type": [
"boolean",
"null"
],
"description": "Enable Smart Cache"
},
"EnableTLS1": {
"type": [
"boolean",
"null"
],
"description": "Determines if the TLS 1 should be enabled on this zone"
},
"EnableTLS1_1": {
"type": [
"boolean",
"null"
],
"description": "Determines if the TLS 1.1 should be enabled on this zone"
},
"EnableWebpVary": {
"type": [
"boolean",
"null"
],
"description": "Determines if the WebP Vary feature should be enabled."
},
"EnableWebSockets": {
"type": [
"boolean",
"null"
],
"description": "Determines if WebSocket connections are allowed for this Pull Zone."
},
"ErrorPageCustomCode": {
"type": [
"string",
"null"
],
"description": "Contains the custom error page code that will be returned"
},
"ErrorPageEnableCustomCode": {
"type": [
"boolean",
"null"
],
"description": "Determines if custom error page code should be enabled."
},
"ErrorPageEnableStatuspageWidget": {
"type": [
"boolean",
"null"
],
"description": "Determines if the statuspage widget should be displayed on the error pages"
},
"ErrorPageStatuspageCode": {
"type": [
"string",
"null"
],
"description": "The statuspage code that will be used to build the status widget"
},
"ErrorPageWhitelabel": {
"type": [
"boolean",
"null"
],
"description": "Determines if the error pages should be whitelabel or not"
},
"FollowRedirects": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone should follow redirects return by the oprigin and cache the response"
},
"IgnoreQueryStrings": {
"type": [
"boolean",
"null"
],
"description": "Determines if the Pull Zone should ignore query strings when serving cached objects (Vary by Query String)"
},
"LimitRateAfter": {
"type": [
"number",
"null"
],
"description": "Determines the amount of traffic transferred before the client is limited"
},
"LimitRatePerSecond": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum number of requests per second coming from a single IP before it is blocked."
},
"LogAnonymizationType": {
"type": [
"integer",
"null"
],
"description": "Sets the log anonymization type for this pull zone",
"enum": [
0,
1
]
},
"LogFormat": {
"type": [
"integer",
"null"
],
"description": "0 = Plain 1 = JSON",
"enum": [
0,
1
]
},
"LogForwardingEnabled": {
"type": [
"boolean",
"null"
],
"description": "Sets the log forwarding token for the zone"
},
"LogForwardingFormat": {
"type": [
"integer",
"null"
],
"description": "0 = Plain 1 = JSON",
"enum": [
0,
1
]
},
"LogForwardingHostname": {
"type": [
"string",
"null"
],
"description": "Sets the log forwarding destination hostname for the zone"
},
"LogForwardingPort": {
"type": [
"integer",
"null"
],
"description": "Sets the log forwarding port for the zone"
},
"LogForwardingProtocol": {
"type": [
"integer",
"null"
],
"description": "Sets the log forwarding protocol type",
"enum": [
0,
1,
2,
3
]
},
"LogForwardingToken": {
"type": [
"string",
"null"
],
"description": "Sets the log forwarding token for the zone"
},
"LoggingIPAnonymizationEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the log anonoymization should be enabled"
},
"LoggingSaveToStorage": {
"type": [
"boolean",
"null"
],
"description": "Determines if the logging permanent storage should be enabled"
},
"LoggingStorageZoneId": {
"type": [
"integer",
"null"
],
"description": "Sets the Storage Zone id that should contain the logs from this Pull Zone"
},
"MagicContainersAppId": {
"type": [
"string",
"null"
],
"description": "Magic Containers App Id"
},
"MagicContainersEndpointId": {
"type": [
"string",
"null"
],
"description": "Magic Containers Endpoint Id"
},
"MaxWebSocketConnections": {
"type": [
"integer",
"null"
],
"description": "The 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."
},
"MiddlewareScriptId": {
"type": [
"integer",
"null"
],
"description": "The ID of the middleware script"
},
"MonthlyBandwidthLimit": {
"type": [
"integer",
"null"
],
"description": "Sets the monthly limit of bandwidth in bytes that the pullzone is allowed to use"
},
"OptimizerAutomaticOptimizationEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the automatic image optimization should be enabled"
},
"OptimizerClasses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"Name": {
"type": "string",
"description": "The name of the optimizer class that will be used in the query string"
},
"Properties": {
"type": "object",
"description": "The list of settings and values the class will send to the optimizer"
}
}
},
"description": "Determines the list of optimizer classes"
},
"OptimizerDesktopMaxWidth": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum automatic image size for desktop clients"
},
"OptimizerEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the optimizer should be enabled for this zone"
},
"OptimizerEnableManipulationEngine": {
"type": [
"boolean",
"null"
],
"description": "Determines the image manipulation should be enabled"
},
"OptimizerEnableUpscaling": {
"type": [
"boolean",
"null"
],
"description": "Determines if Optimizer should automatically upscale images"
},
"OptimizerEnableWebP": {
"type": [
"boolean",
"null"
],
"description": "Determines if the WebP optimization should be enabled"
},
"OptimizerForceClasses": {
"type": [
"boolean",
"null"
],
"description": "Determines if the optimizer classes should be forced"
},
"OptimizerImageQuality": {
"type": [
"integer",
"null"
],
"description": "Determines the image quality for desktop clients"
},
"OptimizerMinifyCSS": {
"type": [
"boolean",
"null"
],
"description": "Determines if the CSS minifcation should be enabled"
},
"OptimizerMinifyJavaScript": {
"type": [
"boolean",
"null"
],
"description": "Determines if the JavaScript minifcation should be enabled"
},
"OptimizerMobileImageQuality": {
"type": [
"integer",
"null"
],
"description": "Determines the image quality for mobile clients"
},
"OptimizerMobileMaxWidth": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum automatic image size for mobile clients"
},
"OptimizerPrerenderHtml": {
"type": [
"boolean",
"null"
],
"description": "Determines if the SEO HTML prerender should be enabled"
},
"OptimizerStaticHtmlEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines whether optimizer static html feature enabled"
},
"OptimizerStaticHtmlWordPressBypassCookie": {
"type": [
"string",
"null"
],
"description": "Wordpress cookie which should be bypassed by permacache in edge rule"
},
"OptimizerStaticHtmlWordPressPath": {
"type": [
"string",
"null"
],
"description": "Wordpress html path which should be bypassed by permacache in edge rule"
},
"OptimizerTunnelEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the optimizer origin tunnel system should be enabled for this zone"
},
"OptimizerWatermarkEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if image watermarking should be enabled"
},
"OptimizerWatermarkMinImageSize": {
"type": [
"integer",
"null"
],
"description": "Sets the minimum image size to which the watermark will be added"
},
"OptimizerWatermarkOffset": {
"type": [
"number",
"null"
],
"description": "Sets the offset of the watermark image"
},
"OptimizerWatermarkPosition": {
"type": [
"integer",
"null"
],
"description": "Sets the position of the watermark image",
"enum": [
0,
1,
2,
3,
4,
5
]
},
"OptimizerWatermarkUrl": {
"type": [
"string",
"null"
],
"description": "Sets the URL of the watermark image"
},
"OriginConnectTimeout": {
"type": [
"integer",
"null"
],
"description": "The amount of seconds to wait when connecting to the origin. Otherwise the request will fail or retry."
},
"OriginHostHeader": {
"type": [
"string",
"null"
],
"description": "Sets the host header that will be sent to the origin"
},
"OriginResponseTimeout": {
"type": [
"integer",
"null"
],
"description": "The amount of seconds to wait when waiting for the origin reply. Otherwise the request will fail or retry."
},
"OriginRetries": {
"type": [
"integer",
"null"
],
"description": "The number of retries to the origin server"
},
"OriginRetry5XXResponses": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should retry the request in case of a 5XX response."
},
"OriginRetryConnectionTimeout": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should retry the request in case of a connection timeout."
},
"OriginRetryDelay": {
"type": [
"integer",
"null"
],
"description": "Determines the amount of time that the CDN should wait before retrying an origin request."
},
"OriginRetryResponseTimeout": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should retry the request in case of a response timeout."
},
"OriginShieldEnableConcurrencyLimit": {
"type": [
"boolean",
"null"
],
"description": "Determines if the origin shield concurrency limit is enabled."
},
"OriginShieldMaxConcurrentRequests": {
"type": [
"integer",
"null"
],
"description": "Determines the number of maximum concurrent requests allowed to the origin."
},
"OriginShieldMaxQueuedRequests": {
"type": [
"integer",
"null"
],
"description": "Determines the max number of origin requests that will remain in the queue"
},
"OriginShieldQueueMaxWaitTime": {
"type": [
"integer",
"null"
],
"description": "Determines the max queue wait time"
},
"OriginShieldZoneCode": {
"type": [
"string",
"null"
],
"description": "Determines the zone code where the origin shield should be set up"
},
"OriginType": {
"type": [
"integer",
"null"
],
"description": "Determine the type of the origin for this Pull Zone",
"enum": [
0,
1,
2,
3,
4,
5,
6
]
},
"OriginUrl": {
"type": [
"string",
"null"
],
"description": "Sets the origin URL of the Pull Zone"
},
"PermaCacheStorageZoneId": {
"type": [
"integer",
"null"
],
"description": "The ID of the storage zone that should be used as the Perma-Cache"
},
"PermaCacheType": {
"type": [
"integer",
"null"
],
"description": "Determines Perma-Cache behavior",
"enum": [
0,
1
]
},
"PreloadingScreenCode": {
"type": [
"string",
"null"
],
"description": "The custom preloading screen coed"
},
"PreloadingScreenCodeEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the custom preloader screen should be enabled"
},
"PreloadingScreenDelay": {
"type": [
"integer",
"null"
],
"description": "The delay in miliseconds after which the preloading screen will be displayed (0 - 10000ms)"
},
"PreloadingScreenEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the preloading screen is currently enabled"
},
"PreloadingScreenLogoUrl": {
"type": [
"string",
"null"
],
"description": "The preloading screen logo URL"
},
"PreloadingScreenShowOnFirstVisit": {
"type": "boolean",
"description": "Determines if the preloading screen is shown on the first load from a user."
},
"PreloadingScreenTheme": {
"type": [
"integer",
"null"
],
"description": "The currently configured preloading screem theme. (0 - Light, 1 - Dark)",
"enum": [
0,
1
]
},
"QueryStringVaryParameters": {
"type": "array",
"items": {
"type": "string"
},
"description": "Contains 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."
},
"RequestCoalescingTimeout": {
"type": [
"integer",
"null"
],
"description": "Determines the lock time for coalesced requests."
},
"RequestLimit": {
"type": [
"integer",
"null"
],
"description": "Determines the maximum number of requests per second that will be allowed to connect to this Pull Zone"
},
"RoutingFilters": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of routing filters enabled for this zone"
},
"ShieldDDosProtectionEnabled": {
"type": [
"boolean",
"null"
],
"description": "Shield D Dos Protection Enabled"
},
"ShieldDDosProtectionType": {
"type": [
"integer",
"null"
],
"description": "0 = DetectOnly 1 = ActiveStandard 2 = ActiveAggressive",
"enum": [
0,
1,
2
]
},
"StickySessionClientHeaders": {
"type": [
"string",
"null"
],
"description": "A set of comma-separated header names used to identify clients"
},
"StickySessionCookieName": {
"type": [
"string",
"null"
],
"description": "Sticky Session Cookie Name"
},
"StickySessionType": {
"type": [
"integer",
"null"
],
"description": "Whether to use a Sticky Session mechanism for this pull zone",
"enum": [
0,
1
]
},
"StorageZoneId": {
"type": [
"integer",
"null"
],
"description": "The ID of the storage zone that will be used as the origin"
},
"Type": {
"type": [
"integer",
"null"
],
"description": "The type of the pull zone. Premium = 0, Volume = 1",
"enum": [
0,
1
]
},
"UseBackgroundUpdate": {
"type": [
"boolean",
"null"
],
"description": "Determines if cache update is performed in the background."
},
"UseStaleWhileOffline": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should use stale cache while the origin is offline"
},
"UseStaleWhileUpdating": {
"type": [
"boolean",
"null"
],
"description": "Determines if we should use stale cache while cache is updating"
},
"VerifyOriginSSL": {
"type": [
"boolean",
"null"
],
"description": "Determines if the SSL certificate should be verified when connecting to the origin"
},
"ZoneSecurityEnabled": {
"type": [
"boolean",
"null"
],
"description": "Determines if the zone token authentication security should be enabled"
},
"ZoneSecurityIncludeHashRemoteIP": {
"type": [
"boolean",
"null"
],
"description": "Determines if the token authentication IP validation should be enabled"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## bunnycdn\_cdn\_purge\_public\_index\_post
Purge URL
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url` | string | Yes | — | The URL that will be purged from cache. |
| `async` | boolean | No | — | (Optional) Determines if the call should wait for the purge logic to complete |
| `exactPath` | boolean | No | — | (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. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"url": {
"type": "string",
"description": "The URL that will be purged from cache."
},
"async": {
"type": "boolean",
"description": "(Optional) Determines if the call should wait for the purge logic to complete"
},
"exactPath": {
"type": "boolean",
"description": "(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."
}
},
"required": [
"PCID",
"url"
]
}
```
***
## bunnycdn\_cdn\_region\_public\_index
Region list
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## bunnycdn\_cdn\_reset\_security\_key\_endpoint\_reset\_security\_key
Reset Token Key
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | --------------------------------- | ------------ |
| `id` | integer | Yes | — | The ID of the requested Pull Zone | |
| `SecurityKey` | string | null | No | — | Security Key |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the requested Pull Zone"
},
"SecurityKey": {
"type": [
"string",
"null"
],
"description": "Security Key"
}
},
"required": [
"PCID",
"id"
]
}
```