External DocumentationTo learn more, visit the Cloudflare documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Account or Zone ID | The account ID or zone ID that the IP Access rules belong to, matching the selected Scope. |
| Configuration Target | Select the target type to search by. |
| Configuration Value | The target value to search for, matching the selected Configuration Target. |
| Mode | Select the rule action to filter results by. |
| Notes | The query to search for in the rule notes. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Scope | Select whether the IP Access rules belong to an account or a zone. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Match | Select whether rules must match all or any of the filter criteria. |
| Order | Select the field to sort the results by. |
| Page | The page number to show results from. |
| Per Page | Maximum number of results per page. |
| Sort Order | Select the direction to sort the results by. |
Example Output
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"id": "92f17202ed8bd63d69a66b86a49a8f6b",
"allowed_modes": [
"whitelist",
"block",
"challenge",
"js_challenge",
"managed_challenge"
],
"configuration": {
"target": "ip",
"value": "198.51.100.4"
},
"mode": "challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"modified_on": "2014-01-01T05:20:00.12345Z",
"notes": "Security event mitigation rule",
"scope": {
"id": "023e105f4ecef8ad9ca31a8372d0c353",
"email": "user@example.com",
"type": "user"
}
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000
}
}