Skip to main content
POST
/
storagezone
Add Storage Zone
curl --request POST \
  --url https://api.bunny.net/storagezone \
  --header 'AccessKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Name": "<string>",
  "Region": "<string>",
  "ReplicationRegions": [
    "<string>"
  ],
  "ZoneTier": 0,
  "StorageZoneType": 0
}
'
{
  "Id": 123,
  "UserId": "<string>",
  "Name": "<string>",
  "Password": "<string>",
  "DateModified": "2023-11-07T05:31:56Z",
  "Deleted": true,
  "StorageUsed": 123,
  "FilesStored": 123,
  "Region": "<string>",
  "ReplicationRegions": [
    "<string>"
  ],
  "PullZones": [
    {
      "Id": 123,
      "Name": "<string>",
      "OriginUrl": "<string>",
      "Enabled": true,
      "Suspended": true,
      "Hostnames": [
        {
          "Id": 123,
          "Value": "<string>",
          "ForceSSL": true,
          "IsSystemHostname": true,
          "IsManagedHostname": true,
          "HasCertificate": true,
          "Certificate": "<string>",
          "CertificateKey": "<string>",
          "CertificateKeyType": 0,
          "CertificateProvisionType": 0
        }
      ],
      "StorageZoneId": 123,
      "EdgeScriptId": 123,
      "EdgeScriptExecutionPhase": 0,
      "MiddlewareScriptId": 123,
      "MagicContainersAppId": "<string>",
      "MagicContainersEndpointId": "<string>",
      "AllowedReferrers": [
        "<string>"
      ],
      "BlockedReferrers": [
        "<string>"
      ],
      "BlockedIps": [
        "<string>"
      ],
      "EnableGeoZoneUS": true,
      "EnableGeoZoneEU": true,
      "EnableGeoZoneASIA": true,
      "EnableGeoZoneSA": true,
      "EnableGeoZoneAF": true,
      "ZoneSecurityEnabled": true,
      "ZoneSecurityKey": "<string>",
      "ZoneSecurityIncludeHashRemoteIP": true,
      "IgnoreQueryStrings": true,
      "MonthlyBandwidthLimit": 123,
      "MonthlyBandwidthUsed": 123,
      "MonthlyCharges": 123,
      "AddHostHeader": true,
      "OriginHostHeader": "<string>",
      "Type": 0,
      "AccessControlOriginHeaderExtensions": [
        "<string>"
      ],
      "EnableAccessControlOriginHeader": true,
      "DisableCookies": true,
      "BudgetRedirectedCountries": [
        "<string>"
      ],
      "BlockedCountries": [
        "<string>"
      ],
      "EnableOriginShield": true,
      "CacheControlMaxAgeOverride": 123,
      "CacheControlPublicMaxAgeOverride": 123,
      "BurstSize": 123,
      "RequestLimit": 123,
      "BlockRootPathAccess": true,
      "BlockPostRequests": true,
      "LimitRatePerSecond": 123,
      "LimitRateAfter": 123,
      "ConnectionLimitPerIPCount": 123,
      "PriceOverride": 123,
      "OptimizerPricing": 123,
      "AddCanonicalHeader": true,
      "EnableLogging": true,
      "EnableCacheSlice": true,
      "EnableSmartCache": true,
      "EdgeRules": [
        {
          "Guid": "<string>",
          "ActionType": 0,
          "ActionParameter1": "<string>",
          "ActionParameter2": "<string>",
          "ActionParameter3": "<string>",
          "Triggers": [
            {
              "Type": 0,
              "PatternMatches": [
                "<string>"
              ],
              "PatternMatchingType": 0,
              "Parameter1": "<string>"
            }
          ],
          "ExtraActions": [
            {
              "ActionType": 0,
              "ActionParameter1": "<string>",
              "ActionParameter2": "<string>",
              "ActionParameter3": "<string>"
            }
          ],
          "TriggerMatchingType": 0,
          "Description": "<string>",
          "Enabled": true,
          "OrderIndex": 123,
          "ReadOnly": true
        }
      ],
      "EnableWebPVary": true,
      "EnableAvifVary": true,
      "EnableCountryCodeVary": true,
      "EnableCountryStateCodeVary": true,
      "EnableMobileVary": true,
      "EnableCookieVary": true,
      "CookieVaryParameters": [
        "<string>"
      ],
      "EnableHostnameVary": true,
      "CnameDomain": "<string>",
      "AWSSigningEnabled": true,
      "AWSSigningKey": "<string>",
      "AWSSigningSecret": "<string>",
      "AWSSigningRegionName": "<string>",
      "LoggingIPAnonymizationEnabled": true,
      "EnableTLS1": true,
      "EnableTLS1_1": true,
      "VerifyOriginSSL": true,
      "ErrorPageEnableCustomCode": true,
      "ErrorPageCustomCode": "<string>",
      "ErrorPageEnableStatuspageWidget": true,
      "ErrorPageStatuspageCode": "<string>",
      "ErrorPageWhitelabel": true,
      "OriginShieldZoneCode": "<string>",
      "LogForwardingEnabled": true,
      "LogForwardingHostname": "<string>",
      "LogForwardingPort": 123,
      "LogForwardingToken": "<string>",
      "LogForwardingProtocol": 0,
      "LoggingSaveToStorage": true,
      "LoggingStorageZoneId": 123,
      "FollowRedirects": true,
      "VideoLibraryId": 123,
      "DnsRecordId": 123,
      "DnsZoneId": 123,
      "DnsRecordValue": "<string>",
      "OptimizerEnabled": true,
      "OptimizerTunnelEnabled": true,
      "OptimizerDesktopMaxWidth": 2500,
      "OptimizerMobileMaxWidth": 2500,
      "OptimizerImageQuality": 50,
      "OptimizerMobileImageQuality": 50,
      "OptimizerEnableWebP": true,
      "OptimizerPrerenderHtml": true,
      "OptimizerEnableManipulationEngine": true,
      "OptimizerMinifyCSS": true,
      "OptimizerMinifyJavaScript": true,
      "OptimizerWatermarkEnabled": true,
      "OptimizerWatermarkUrl": "<string>",
      "OptimizerWatermarkPosition": 0,
      "OptimizerWatermarkOffset": 123,
      "OptimizerWatermarkMinImageSize": 123,
      "OptimizerAutomaticOptimizationEnabled": true,
      "PermaCacheStorageZoneId": 123,
      "PermaCacheType": 0,
      "OriginRetries": 123,
      "OriginConnectTimeout": 123,
      "OriginResponseTimeout": 123,
      "UseStaleWhileUpdating": true,
      "UseStaleWhileOffline": true,
      "OriginRetry5XXResponses": true,
      "OriginRetryConnectionTimeout": true,
      "OriginRetryResponseTimeout": true,
      "OriginRetryDelay": 123,
      "QueryStringVaryParameters": [
        "<string>"
      ],
      "OriginShieldEnableConcurrencyLimit": true,
      "OriginShieldMaxConcurrentRequests": 123,
      "EnableSafeHop": true,
      "CacheErrorResponses": true,
      "OriginShieldQueueMaxWaitTime": 123,
      "OriginShieldMaxQueuedRequests": 123,
      "OptimizerClasses": [
        {
          "Name": "<string>",
          "Properties": {}
        }
      ],
      "OptimizerForceClasses": true,
      "OptimizerStaticHtmlEnabled": true,
      "OptimizerStaticHtmlWordPressPath": "<string>",
      "OptimizerStaticHtmlWordPressBypassCookie": "<string>",
      "UseBackgroundUpdate": true,
      "EnableAutoSSL": true,
      "EnableQueryStringOrdering": true,
      "LogAnonymizationType": 0,
      "LogFormat": 0,
      "LogForwardingFormat": 0,
      "ShieldDDosProtectionType": 0,
      "ShieldDDosProtectionEnabled": true,
      "OriginType": 0,
      "EnableRequestCoalescing": true,
      "RequestCoalescingTimeout": 123,
      "OriginLinkValue": "<string>",
      "DisableLetsEncrypt": true,
      "EnableBunnyImageAi": true,
      "BunnyAiImageBlueprints": [
        {
          "Name": "<string>",
          "Properties": {}
        }
      ],
      "PreloadingScreenEnabled": true,
      "PreloadingScreenShowOnFirstVisit": true,
      "PreloadingScreenCode": "<string>",
      "PreloadingScreenLogoUrl": "<string>",
      "PreloadingScreenCodeEnabled": true,
      "PreloadingScreenTheme": 0,
      "PreloadingScreenDelay": 123,
      "EUUSDiscount": 123,
      "SouthAmericaDiscount": 123,
      "AfricaDiscount": 123,
      "AsiaOceaniaDiscount": 123,
      "RoutingFilters": [
        "<string>"
      ],
      "BlockNoneReferrer": true,
      "StickySessionType": 0,
      "StickySessionCookieName": "<string>",
      "StickySessionClientHeaders": "<string>",
      "UserId": "<string>",
      "CacheVersion": 123,
      "OptimizerEnableUpscaling": true,
      "EnableWebSockets": true,
      "MaxWebSocketConnections": 123,
      "EnableExtendedLogging": true
    }
  ],
  "ReadOnlyPassword": "<string>",
  "Rewrite404To200": true,
  "Custom404FilePath": "<string>",
  "StorageHostname": "<string>",
  "ZoneTier": 0,
  "ReplicationChangeInProgress": true,
  "PriceOverride": 123,
  "Discount": 123,
  "StorageZoneType": 0
}

Documentation Index

Fetch the complete documentation index at: https://docs.bunny.net/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
AccessKey
string
header
required

API Access Key authorization header

Body

application/json

The storage zone that will be added

​
Name
string
required

The name of the storage zone

Minimum string length: 1
​
Region
string
required

The code of the main storage zone region (Possible values: DE, NY, LA, SG)

Minimum string length: 1
​
ReplicationRegions
string[] | null

The code of the main storage zone region (Possible values: DE, NY, LA, SG, SYD)

​
ZoneTier
enum<integer>

Determines the storage zone tier that will be storing the data

Available options:
0,
1
​
StorageZoneType
enum<integer>

The Storage Zone S3 support type

Available options:
0,
1

Response

The storage zone that was added

​
Id
integer<int64>

The ID of the storage zone

​
UserId
string | null

The ID of the user that owns the storage zone

​
Name
string | null

The name of the storage zone

​
Password
string | null

The API access key or FTP password

​
DateModified
string<date-time>

The date when the zone was last modified

​
Deleted
boolean

Determines if the zone was deleted or not

​
StorageUsed
integer<int64>

The total amount of storage used by this zone

​
FilesStored
integer<int64>

The total number of files stored by this zone

​
Region
string | null

The main region used by the storage zone

​
ReplicationRegions
string[] | null

The replication regions enabled for this storage zone

​
PullZones
object[] | null

The list of pull zones connected to this storage zone

​
ReadOnlyPassword
string | null

The read-only API access key or FTP password

​
Rewrite404To200
boolean

Determines if the storage zone will rewrite 404 status codes to 200 status codes

​
Custom404FilePath
string | null

The custom 404 error path that will be returned in case of a missing file.

​
StorageHostname
string | null

Determines the storage hostname for this zone

​
ZoneTier
enum<integer>

Determines the storage zone tier that is storing the data

Available options:
0,
1
​
ReplicationChangeInProgress
boolean

Determines if the storage zone is currently enabling a new replication region

​
PriceOverride
number<decimal>

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

​
Discount
integer<int32>

The Storage Zone specific pricing discount.

​
StorageZoneType
enum<integer>

The Storage Zone S3 support type

Available options:
0,
1