Retrieves a list of the available rule sets.
The purpose of this endpoint is to identify each rule set/version combination (e.g., ECRS) that may be assigned to a managed rule.
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 managed rules, it is always a best practice to review and update managed rules to use the latest version whenever possible.
A request to retrieve rule sets is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/v1.0/profile/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 |
---|---|
Required |
|
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
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. |
The response body for an unsuccessful request will contain an error response that provides additional information.
A sample JSON request is shown below.
GET https://api.transactcdn.com/v2/mcc/customers/0001/waf/v1.0/profile/rulesets HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Content-Type: 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: 665
[{ "id": "ECRS", "description": "NA", "versions": [ "2018-09-14", "2019-02-11", "2019-08-07", "2019-09-05", "2019-10-01", "2019-11-01", "2020-01-09", "2020-02-04", "2020-03-06", "2020-04-03", "2020-05-01", "2020-06-08", "2020-08-01", "2020-09-01", "2020-10-05", "2020-11-02", "2020-12-04", "2021-01-04", "2021-02-05", "2021-03-01", "2021-03-09", "2021-04-02", "2021-05-03", "2021-06-01", "2021-07-01", "2021-08-03", "2021-09-07", "2021-10-04", "2021-11-04", "2021-12-10", "2021-12-13", "latest" ], "display": "ECRS" } ]