The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).
/zones/{zone_identifier}/settings/waf
get
Zone Settings
zone-settings-get-web-application-firewall-(-waf)-setting
{
"business": true,
"enterprise": true,
"free": false,
"pro": true
}{
"enum": [
"#zone_settings:read"
]
}[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"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"
},
"success": {
"description": "Whether the API call was successful",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
}
}
]
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"editable": {
"default": true,
"description": "Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).",
"enum": [
true,
false
],
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "Identifier of the zone setting.",
"example": "development_mode",
"type": "string"
},
"modified_on": {
"description": "last time this setting was modified.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"value": {
"description": "Current value of the zone setting.",
"example": "on"
}
},
"required": [
"id",
"value"
]
},
{
"properties": {
"id": {
"description": "ID of the zone setting.",
"enum": [
"waf"
],
"example": "waf"
},
"value": {
"default": "off",
"description": "Value of the zone setting.",
"enum": [
"on",
"off"
],
"type": "string"
}
}
}
],
"description": "The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).",
"title": "Web Application Firewall"
}
}
}
]
}
}
},
"description": "Get Web Application Firewall (WAF) setting response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"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": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Get Web Application Firewall (WAF) setting response failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]