Share via

Websites - Get WAF Rules

Service:
Power Platform API
API Version:
2022-03-01-preview

Get the web application firewall rules associated with the given website.

GET https://api.powerplatform.com/powerpages/environments/{environmentId}/websites/{id}/getWafRules?api-version=2022-03-01-preview
With optional parameters: 
GET https://api.powerplatform.com/powerpages/environments/{environmentId}/websites/{id}/getWafRules?ruleType={ruleType}&api-version=2022-03-01-preview

URI Parameters

Name In Required Type Description
environmentId
 path True

string

The environment ID.
id
 path True

string

Website unique identifier (ID).
api-version
 query True

string

The API version.
ruleType
 query

string

Type of web application firewall rules to retrieve.

Responses

Name Type Description
200 OK

WebApplicationFirewallConfiguration

Success
400 Bad Request

ErrorMessage

Bad Request
401 Unauthorized

ErrorMessage

Unauthorized
404 Not Found

ErrorMessage

Not Found

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name Description
.default .default

Definitions

Name Description
CustomRule
Details
Error
ErrorMessage
ManagedRules
MatchConditions
RuleGroupOverrides
Rules
WafRuleAction

Action to take for the rule
WafRuleType
WebApplicationFirewallConfiguration

CustomRule

Object
Name Type Description
action enum:
  • Allow
  • Block
  • Log

Action to take when the rule matches
enabledState enum:
  • Disabled
  • Enabled

State of the rule
matchConditions

MatchConditions[]

name

string

Name of the custom rule
priority

integer (int32)

Priority of the rule
rateLimitDurationInMinutes

integer (int32)

Duration in minutes for rate limiting
rateLimitThreshold

integer (int32)

Threshold for rate limiting
ruleType

WafRuleType

Details

Object
Name Type Description
code

string

Error code
message

string

Error message
target

string

Target parameter

Error

Object
Name Type Description
code

string

Error code
details

Details[]

message

string

Error message
target

string

Target parameter

ErrorMessage

Object
Name Type Description
error

Error

ManagedRules

Object
Name Type Description
Exclusions

string[]

List of exclusions for the rule set
RuleGroupOverrides

RuleGroupOverrides[]

RuleSetAction enum:
  • Allow
  • Block
  • Log

Action to take for the rule set
RuleSetType

string

Type of the managed rule set
RuleSetVersion

string

Version of the managed rule set

MatchConditions

Object
Name Type Description
matchValue

string[]

Values to match
matchVariable

string

Variable to match
negateCondition

boolean

Whether to negate the condition
operator enum:
  • Contains
  • EndsWith
  • Equals
  • GeoMatch
  • StartsWith

Operator for the match condition
selector

string

Selector for the match variable
transforms

string[]

Transformations to apply

RuleGroupOverrides

Object
Name Type Description
Exclusions

string[]

List of exclusions for the rule group
RuleGroupName

string

Name of the rule group
Rules

Rules[]

Rules

Object
Name Type Description
Action

WafRuleAction

Action to take for the rule
EnabledState enum:
  • Disabled
  • Enabled

State of the rule
Exclusions

string[]

List of exclusions for the rule
RuleId

string

ID of the rule

WafRuleAction

Enumeration

Action to take for the rule

Value Description
Allow
Block
Log
AnomalyScoring

WafRuleType

Enumeration
Value Description
MatchRule
RateLimitRule

WebApplicationFirewallConfiguration

Object
Name Type Description
CustomRules

CustomRule[]

ManagedRules

ManagedRules[]