Skip to main content
PATCH
/
shield
/
shield-zone
/
{shieldZoneId}
/
api-guardian
Update the API Guardian configuration (enabled, execution mode, body limit action)
curl --request PATCH \
  --url https://api.bunny.net/shield/shield-zone/{shieldZoneId}/api-guardian \
  --header 'Content-Type: application/json' \
  --data '
{
  "isEnabled": true
}
'
import requests

url = "https://api.bunny.net/shield/shield-zone/{shieldZoneId}/api-guardian"

payload = { "isEnabled": True }
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({isEnabled: true})
};

fetch('https://api.bunny.net/shield/shield-zone/{shieldZoneId}/api-guardian', 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/shield-zone/{shieldZoneId}/api-guardian",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'isEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.bunny.net/shield/shield-zone/{shieldZoneId}/api-guardian"

payload := strings.NewReader("{\n \"isEnabled\": true\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Content-Type", "application/json")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.bunny.net/shield/shield-zone/{shieldZoneId}/api-guardian")
.header("Content-Type", "application/json")
.body("{\n \"isEnabled\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/shield/shield-zone/{shieldZoneId}/api-guardian")

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

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"isEnabled\": true\n}"

response = http.request(request)
puts response.read_body
{
  "error": {
    "success": true,
    "message": "<string>",
    "errorKey": "<string>"
  },
  "data": {
    "shieldZoneId": 123,
    "isEnabled": true,
    "title": "<string>",
    "version": "<string>",
    "maxEndpoints": 123,
    "maxFieldsPerType": 123,
    "maxNestingDepth": 123,
    "maxTotalSchemaNodes": 123,
    "maxTotalRegexLength": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}
{
"error": {
"success": true,
"message": "<string>",
"errorKey": "<string>"
},
"data": {
"shieldZoneId": 123,
"isEnabled": true,
"title": "<string>",
"version": "<string>",
"maxEndpoints": 123,
"maxFieldsPerType": 123,
"maxNestingDepth": 123,
"maxTotalSchemaNodes": 123,
"maxTotalRegexLength": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
{
"error": {
"success": true,
"message": "<string>",
"errorKey": "<string>"
},
"data": {
"shieldZoneId": 123,
"isEnabled": true,
"title": "<string>",
"version": "<string>",
"maxEndpoints": 123,
"maxFieldsPerType": 123,
"maxNestingDepth": 123,
"maxTotalSchemaNodes": 123,
"maxTotalRegexLength": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}

Path Parameters

shieldZoneId
integer<int32>
required

Body

Patch request for updating the global API Guardian configuration. All fields are optional — only provided fields are applied.

isEnabled
boolean | null

Enable or disable API Guardian entirely for this shield zone.

executionMode
enum<integer>

0 = Log 1 = Block

Available options:
0,
1
bodyLimitAction
enum<integer>

0 = Block 1 = Log 2 = Ignore

Available options:
0,
1,
2
unmatchedPathAction
enum<integer>

0 = Block 1 = Log 2 = Ignore

Available options:
0,
1,
2

Response

OK

Response for the PATCH /configuration endpoint.

error
object

Generic response object containing status information for API operations.

data
object

Global API Guardian configuration for a shield zone.

Last modified on July 12, 2026