Skip to content

Toggle a global scenario for a zone

PATCH
/api/zones/{zoneId}/security/global-scenarios/{id}

Turns a global scenario on or off for this zone by recording the zone's explicit preference; the global scenario itself is never modified. Send enabledForZone. The explicit choice is always recorded so it survives a later change of the scenario's participation mode.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

zoneId*

zone-global-scenario identifier

Type
string
Required
id*

zone-global-scenario identifier

Type
string
Required

Request Body

application/merge-patch+json
JSON
{
  
"enabledForZone": true
}

Responses

zone-global-scenario resource updated

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "0193b3e2-6c1a-7f2a-9a1b-2d3e4f5a6b7c",
  
"name": "block-sql-injection",
  
"testing": false,
  
"evaluationScope": "ip",
  
"definition": "name: block-sql-injection enabled: true testing: false scope: ip ",
  
"enabledForZone": true
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI