Fetches filters in a zone. You can filter the results using several optional parameters.
/zones/{zone_identifier}/filters
get
Filters
filters-list-filters
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}null[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "paused",
"schema": {
"description": "When true, indicates that the filter is currently paused.",
"example": false,
"type": "boolean"
}
},
{
"in": "query",
"name": "expression",
"schema": {
"description": "A case-insensitive string to find in the expression.",
"example": "php",
"type": "string"
}
},
{
"in": "query",
"name": "description",
"schema": {
"description": "A case-insensitive string to find in the description.",
"example": "browsers",
"type": "string"
}
},
{
"in": "query",
"name": "ref",
"schema": {
"description": "The filter ref (a short reference tag) to search for. Must be an exact match.",
"example": "FIL-100",
"type": "string"
}
},
{
"in": "query",
"name": "page",
"schema": {
"default": 1,
"description": "Page number of paginated results.",
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"default": 25,
"description": "Number of filters per page.",
"maximum": 100,
"minimum": 5,
"type": "number"
}
},
{
"in": "query",
"name": "id",
"schema": {
"description": "The unique identifier of the filter.",
"example": "372e67954025e0ba6aaa6d586b9e0b61",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"description": {
"description": "An informative summary of the filter.",
"example": "Restrict access from these browsers on this address range.",
"maxLength": 500,
"type": "string"
},
"expression": {
"description": "The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).",
"example": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"type": "string"
},
"id": {
"description": "The unique identifier of the filter.",
"example": "372e67954025e0ba6aaa6d586b9e0b61",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
},
"paused": {
"description": "When true, indicates that the filter is currently paused.",
"example": false,
"type": "boolean"
},
"ref": {
"description": "A short reference tag. Allows you to select related filters.",
"example": "FIL-100",
"maxLength": 50,
"type": "string"
}
},
"type": "object"
},
{
"required": [
"id",
"expression",
"paused"
],
"type": "object"
}
]
},
"type": "array"
}
},
"type": "object"
}
]
}
}
},
"description": "List filters response"
},
"4xx": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"description": {
"description": "An informative summary of the filter.",
"example": "Restrict access from these browsers on this address range.",
"maxLength": 500,
"type": "string"
},
"expression": {
"description": "The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).",
"example": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
"type": "string"
},
"id": {
"description": "The unique identifier of the filter.",
"example": "372e67954025e0ba6aaa6d586b9e0b61",
"maxLength": 32,
"minLength": 32,
"readOnly": true,
"type": "string"
},
"paused": {
"description": "When true, indicates that the filter is currently paused.",
"example": false,
"type": "boolean"
},
"ref": {
"description": "A short reference tag. Allows you to select related filters.",
"example": "FIL-100",
"maxLength": 50,
"type": "string"
}
},
"type": "object"
},
{
"required": [
"id",
"expression",
"paused"
],
"type": "object"
}
]
},
"type": "array"
}
},
"type": "object"
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "List filters response failure"
}
}[
{
"api_email": [],
"api_key": []
},
{
"api_token": []
}
]