Skip to content

List global scenarios for a zone

GET
/api/zones/{zoneId}/security/global-scenarios

Returns the active global scenarios (enabled and not testing) as seen by this zone. Each entry carries enabledForZone, the zone's effective on/off state: its explicit preference when set, otherwise the scenario's participation-mode default (opt-out on, opt-in off).

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 identifier

Type
string
Required

Query Parameters

page

The collection page number

Type
integer
Default
1
itemsPerPage

The number of items per page

Type
integer
Default
30
Minimum
0
Maximum
100

Responses

zone-global-scenario collection

JSON
{
  
"totalItems": 0,
  
"search": {
  
  
"@type": "string",
  
  
"template": "string",
  
  
"variableRepresentation": "string",
  
  
"mapping": [
  
  
  
{
  
  
  
  
"@type": "string",
  
  
  
  
"variable": "string",
  
  
  
  
"property": "string",
  
  
  
  
"required": true
  
  
  
}
  
  
]
  
},
  
"view": {
  
  
"@id": "string",
  
  
"@type": "string",
  
  
"first": "string",
  
  
"last": "string",
  
  
"previous": "string",
  
  
"next": "string"
  
},
  
"member": [
  
  
{
  
  
  
"@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

Samples

Powered by VitePress OpenAPI