List Storage Zones

GET /storagezone

List Storage Zones

cURL

curl --request GET \
  --url https://api.bunny.net/storagezone \
  --header 'AccessKey: <api-key>'

import requests

url = "https://api.bunny.net/storagezone"

headers = {"AccessKey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {AccessKey: '<api-key>'}};

fetch('https://api.bunny.net/storagezone', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bunny.net/storagezone",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "AccessKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.bunny.net/storagezone"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("AccessKey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.bunny.net/storagezone")
  .header("AccessKey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/storagezone")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["AccessKey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

[
  {
    "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>"
          }
        ],
        "StorageZoneId": 123,
        "EdgeScriptId": 123,
        "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>",
        "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>",
            "ActionParameter1": "<string>",
            "ActionParameter2": "<string>",
            "ActionParameter3": "<string>",
            "Triggers": [
              {
                "PatternMatches": [
                  "<string>"
                ],
                "Parameter1": "<string>"
              }
            ],
            "ExtraActions": [
              {
                "ActionParameter1": "<string>",
                "ActionParameter2": "<string>",
                "ActionParameter3": "<string>"
              }
            ],
            "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>",
        "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>",
        "OptimizerWatermarkOffset": 123,
        "OptimizerWatermarkMinImageSize": 123,
        "OptimizerAutomaticOptimizationEnabled": true,
        "PermaCacheStorageZoneId": 123,
        "OriginRetries": 123,
        "OriginConnectTimeout": 123,
        "OriginResponseTimeout": 123,
        "UseStaleWhileUpdating": true,
        "UseStaleWhileOffline": true,
        "OriginRetry5XXResponses": true,
        "OriginRetryConnectionTimeout": true,
        "OriginRetryResponseTimeout": true,
        "OriginRetryDelay": 123,
        "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,
        "ShieldDDosProtectionEnabled": true,
        "EnableRequestCoalescing": true,
        "RequestCoalescingTimeout": 123,
        "OriginLinkValue": "<string>",
        "DisableLetsEncrypt": true,
        "EnableBunnyImageAi": true,
        "BunnyAiImageBlueprints": [
          {
            "Name": "<string>",
            "Properties": {}
          }
        ],
        "PreloadingScreenEnabled": true,
        "PreloadingScreenShowOnFirstVisit": true,
        "PreloadingScreenCode": "<string>",
        "PreloadingScreenLogoUrl": "<string>",
        "PreloadingScreenCodeEnabled": true,
        "PreloadingScreenDelay": 123,
        "EUUSDiscount": 123,
        "SouthAmericaDiscount": 123,
        "AfricaDiscount": 123,
        "AsiaOceaniaDiscount": 123,
        "RoutingFilters": [
          "<string>"
        ],
        "BlockNoneReferrer": true,
        "StickySessionCookieName": "<string>",
        "StickySessionClientHeaders": "<string>",
        "UserId": "<string>",
        "CacheVersion": 123,
        "OptimizerEnableUpscaling": true,
        "EnableWebSockets": true,
        "MaxWebSocketConnections": 123,
        "EnableExtendedLogging": true,
        "CacheKeyHeaders": "<string>"
      }
    ],
    "ReadOnlyPassword": "<string>",
    "Rewrite404To200": true,
    "Custom404FilePath": "<string>",
    "StorageHostname": "<string>",
    "ReplicationChangeInProgress": true,
    "PriceOverride": 123,
    "Discount": 123
  }
]

Authorizations

AccessKey · string · header · required

API Access Key authorization header

Query Parameters

page · integer<int32> · default: 0

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.

Required range: 1 <= x <= 2147483647

perPage · integer<int32> · default: 1000

Required range: 5 <= x <= 1000

includeDeleted · boolean · default: false

search · string | null

The search term that will be used to filter the results

Response

200

application/json

The list of storage zones on the account. When the page parameter is set to a value greater than 0, the response will be a paginated object with Items, CurrentPage, TotalItems and HasMoreItems properties instead of a plain array.

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

Show child attributes

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