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}
{
  "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>"
  }
}

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.