Get Available Rule Sets

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 a list of the available rule sets.

The purpose of this endpoint is to identify each rule set/version combination (e.g., Trustwave-OWASPIntegration-Application version 2017-09-18) that may be assigned to a profile.

The set of supported versions for a given rule set is subject to change as new versions are made available. Although this doesn't affect existing profiles, it is always a best practice to review and update profiles to use the latest version whenever possible.

Request

A request to retrieve rule sets is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/config/profiles/rulesets

Define the following variable 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.

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 set returned by this endpoint:

Name Data Type Description

description

String

This parameter is reserved for future use.

id

String

Identifies a rule set by its system-defined ID.

versions

Array (String values)

Identifies the current versions of the rule set 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.

GET https://api.transactcdn.com/v2/mcc/customers/0001/waf/config/profiles/rulesets HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host:api.transactcdn.com

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 294

[{
		"description": "NA",
		"id": "OWASP-CRS-2.2.9",
		"versions": [
			"2017-08-01"
		]
	}, {
		"description": "NA",
		"id": "Trustwave-OWASPIntegration-Application",
		"versions": [
			"2017-08-01",
			"2017-08-16",
			"2017-09-18"
		]
	}
]