Skip to main content
GET
/
shield
/
metrics
/
overages
/
{shieldZoneId}
Get the overage breakdown for the specified Shield Zone for a given month, segmented by billing plan changes
curl --request GET \
  --url https://api.bunny.net/shield/metrics/overages/{shieldZoneId}
import requests

url = "https://api.bunny.net/shield/metrics/overages/{shieldZoneId}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.bunny.net/shield/metrics/overages/{shieldZoneId}', 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/shield/metrics/overages/{shieldZoneId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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/shield/metrics/overages/{shieldZoneId}"

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

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/shield/metrics/overages/{shieldZoneId}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/shield/metrics/overages/{shieldZoneId}")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "shieldZoneId": 123,
  "year": 123,
  "month": 123,
  "totalOverage": 123,
  "totalCleanRequests": 123,
  "segments": [
    {
      "periodStart": "2023-11-07T05:31:56Z",
      "periodEnd": "2023-11-07T05:31:56Z",
      "overageAllowance": 123,
      "overage": 123
    }
  ],
  "error": {
    "success": true,
    "message": "<string>",
    "errorKey": "<string>"
  }
}
{
"statusCode": 123
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}

Path Parameters

shieldZoneId
integer<int32>
required

The ID of the Shield Zone.

Query Parameters

year
integer<int32>

The calendar year to query.

month
integer<int32>

The calendar month (1-12) to query.

Response

OK

shieldZoneId
integer<int32>
year
integer<int32>
month
integer<int32>
totalOverage
integer<int64>
totalCleanRequests
integer<int64>
segments
object[] | null
error
object

Generic response object containing status information for API operations.

Last modified on June 26, 2026