Skip to content

List a zone's manual blocks

GET
/api/zones/{zoneId}/security/blocks

Returns the per-zone manual blocklist for the given zone. Supports a substring search on the source (q) and filtering by action and source type; the geo field is populated for IP entries only.

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
q

Substring match on the source (IP/CIDR/ASN).

Type
string
action

Filter by action.

Type
string
Valid values
"block""challenge"
type

Filter by source type.

Type
string
Valid values
"ip""cidr""asn"

Responses

zone-block 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",
  
  
  
"geo": {
  
  
  
  
"country": "US",
  
  
  
  
"country_name": "United States",
  
  
  
  
"region": "California",
  
  
  
  
"city": "San Francisco",
  
  
  
  
"latitude": 37.77,
  
  
  
  
"longitude": -122.42,
  
  
  
  
"accuracy_radius_km": 20,
  
  
  
  
"asn": 15169,
  
  
  
  
"asn_organization": "Google LLC"
  
  
  
},
  
  
  
"source": "203.0.113.10",
  
  
  
"action": "block",
  
  
  
"type": "ip",
  
  
  
"id": "MjAzLjAuMTEzLjEw"
  
  
}
  
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI