Skip to content

List a zone's allowlist entries​

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

Returns the per-zone allowlist of trusted IP and CIDR sources for the given zone. IP entries include geo data. ASN sources are not supported for zone allowlists.

Authorizations​

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.

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
order[source]

Sort by source (default asc). Entries carry no creation or expiry date, so the source is the only sort key.

Type
string
Valid values
"asc""desc"
type

Filter by source type.

Type
string
Valid values
"ip""cidr"

Responses​

zone-allow 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",
  
  
  
"origin": "manual",
  
  
  
"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.5",
  
  
  
"type": "ip",
  
  
  
"id": "MjAzLjAuMTEzLjU"
  
  
}
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI