Skip to content

List access rules for a zone

GET
/api/zones/{zoneId}/access-rules

Returns the access rules configured for the given zone, sorted by execution order in descending order. Use the "name" query parameter to filter the results by rule name.

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
name

Filter access rules by name (partial match).

Type
string
name[]

Filter access rules by name (partial match).

Type
array

Responses

access-rule 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": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  
  
  
"zone": "https://example.com/",
  
  
  
"name": "Block office IP range",
  
  
  
"description": "Blocks traffic originating from the corporate office subnet.",
  
  
  
"conditions": {
  
  
  
  
"logic": "string",
  
  
  
  
"conditions": [
  
  
  
  
  
{
  
  
  
  
  
  
"field": "string",
  
  
  
  
  
  
"operator": "string",
  
  
  
  
  
  
"target": "X-Custom-Header",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
},
  
  
  
"action": "string",
  
  
  
"skipTargets": [
  
  
  
],
  
  
  
"order": 10,
  
  
  
"enabled": true,
  
  
  
"stopOnMatch": false,
  
  
  
"createdAt": "2026-01-15T09:30:00+00:00",
  
  
  
"updatedAt": "2026-01-20T14:45:00+00:00"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI