Query WAF Settings for a Site Using GetSiteWafSettings API - Edge Security Acceleration

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	No	Site ID, which can be obtained by calling the ListSites API.	1
SiteVersion	integer	No	Site version.	0
Path	string	No	Specifies the configuration path. If not provided, all configurations will be retrieved. Valid values: bot_management : Simple Mode Bots add_security_headers : Adding security response headers client_ip_identifier : Client IP Definition add_bot_protection_headers : Adding security request headers security_level : Security Level	bot_management

Response elements

Element	Type	Description	Example
	object	Response result.
RequestId	string	Request ID.	36af3fcc-43d0-441c-86b1-428951dc8225
Settings	WafSiteSettings	Details of site WAF configuration.

Examples

Success response

JSON format

{
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "Settings": {
    "ClientIpIdentifier": {
      "Headers": [
        "X-Forwarded-For"
      ],
      "Mode": "headers"
    },
    "AddBotProtectionHeaders": {
      "Enable": false
    },
    "AddSecurityHeaders": {
      "Enable": false
    },
    "SecurityLevel": {
      "Value": "low"
    },
    "BotManagement": {
      "DefiniteBots": {
        "Action": "captcha",
        "Id": 20000001
      },
      "LikelyBots": {
        "Action": "deny",
        "Id": 20000002
      },
      "JSDetection": {
        "Enable": false
      },
      "VerifiedBots": {
        "Action": "bypass",
        "Id": 20000003
      },
      "EffectOnStatic": {
        "Enable": true
      }
    },
    "BandwidthAbuseProtection": {
      "Status": "on",
      "Action": "deny",
      "Id": 10000001
    },
    "DisableSecurityModule": {
      "Status": "on"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is invalid.	The specified parameter is invalid.
400	InternalException	Failed to call the service. Try again later or contact technical support.	Failed to call the service. Try again later or contact technical support.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.