Get All Custom Rule Sets

WAF Insights does not support automation via our REST API web service. If you are currently using WAF Insights, upgrade your WAF solution to take advantage of our REST API.

Retrieves a list of custom rule sets. A custom rule set allows you to define custom threat assessment criterion.

Request

A request to retrieve all custom rule sets is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/v1.0/rules

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 elements for each custom rule set:

Name Data Type Description

id

String

Indicates the system-defined ID for the custom rule set.

Pass this ID to the Get Custom Rule Set endpoint to retrieve the properties for this custom rule set.

last_modified_date

String

Indicates the date and time at which the custom rule was last modified.

Syntax:

MM/DD/YYYYhh:mm:ss [AM|PM]

name

String

Indicates the name of the custom rule set.

Errors

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

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

GET https://api.transactcdn.com/v2/mcc/customers/0001/waf/v1.0/rules 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: 141

[
    {
        "name": "My Custom Rule",
        "last_modified_date": "2020-12-17T20:44:23.695323Z",
        "id": "VSgeVhmb"
    }
]