Get Available Rules

This article explains the legacy version of WAF that underwent end-of-life on June 30, 2021. Our new version of WAF expands upon all of the capabilities offered by WAF (Legacy) and Rate Limiting (Legacy) with a simplified and centralized setup. Please upgrade to the latest version of WAF at your earliest convenience.

Retrieves the set of rules associated with the specified policy.

The set of rules associated with a policy may vary by a rule set's version.

Request

A request to retrieve rules is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/config/profiles/rulesets/RuleSetID/version/RuleSetVersion/policies/PolicyID/rules

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper left-hand corner of the TCC.
RuleSetID Required	Replace this variable with the system-defined ID of the rule set that contains the policy whose rules will be retrieved. Use either the Get Profile by ID endpoint to find out the system-defined ID of the rule setThis ID is reported by the ruleset_id response parameter. associated with the desired profile. Alternatively, a list of the available rule sets and their system-defined IDs may be retrieved through the Get Available Rule Sets endpoint.
RuleSetVersion Required	Replace this variable with the version of the rule set that contains the policy whose rules will be retrieved. Use either the Get Profile by ID endpoint to find out the version of the rule setThis version is reported by the ruleset_version response parameter. associated with the desired profile. Alternatively, a list of the available rule sets and their supported versions may be retrieved through the Get Available Rule Sets endpoint.
PolicyID Required	Replace this variable with the system-defined ID of the policy whose rules will be retrieved. Use the Get Available Policies endpoint to retrieve a list of the available policies and their system-defined IDs.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters for each rule returned by this endpoint:

Name	Data Type	Description
Id	Integer	Identifies a rule by its system-defined ID.
Msg	String	Describes the rule identified by the Id response parameter.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

View common error messages.

Sample Request and Response

A sample JSON request is shown below.

A sample JSON response is shown below.

[{
		"Id" : 990002,
		"Msg" : "Request Indicates a Security Scanner Scanned the Site"
	}, {
		"Id" : 990901,
		"Msg" : "Request Indicates a Security Scanner Scanned the Site"
	}, {
		"Id" : 990902,
		"Msg" : "Request Indicates a Security Scanner Scanned the Site"
	}, {
		"Id" : 990012,
		"Msg" : "Rogue web site crawler"
	}
]