Get Available Policies

Retrieves a list of the available policies for the specified rule set.

Request

A request to retrieve policies is described below.

HTTP Method Request URI

GET

https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/v1.0/profile/rulesets/RuleSetID/version/RuleSetVersion/policies

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 whose policies will be retrieved.

Use the Get Managed Rule 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 managed rule. Alternatively, retrieve a list of the available rule sets and their system-defined IDs through the Get Available Rule Sets endpoint.

RuleSetVersion

Required

Replace this variable with the version of the rule set whose policies will be retrieved.

Use the Get Managed Rule endpoint to find out the version of the rule setThis version is reported by the ruleset_version response parameter. associated with the desired managed rule. Alternatively, retrieve a list of the available rule sets and their system-defined IDs through the Get Available Rule Sets endpoint.

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

Name Data Type Description

index

String

Identifies a policy by its index number.

id

String

Identifies a policy by its system-defined ID.

name

String

Identifies a policy by its name.

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/v1.0/profile/rulesets/ECRS/version/latest/policies 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: 2603

[{
		"id": "r2000_ec_custom_rule.conf.json",
		"name": "EC Custom Rule",
		"index": "2000"
	}, {
		"id": "r4000_tw_ip_reputation.conf.json",
		"name": "TW IP Reputation",
		"index": "4000"
	}, {
		"id": "r4010_tw_struts.conf.json",
		"name": "Adv Struts",
		"index": "4010"
	}, {
		"id": "r4020_tw_cpanel.conf.json",
		"name": "Adv cPanel",
		"index": "4020"
	}, {
		"id": "r4030_tw_iis.conf.json",
		"name": "Adv IIS",
		"index": "4030"
	}, {
		"id": "r4040_tw_drupal.conf.json",
		"name": "Adv Drupal",
		"index": "4040"
	}, {
		"id": "r4050_tw_microsoft_sharepoint.conf.json",
		"name": "Adv Sharepoint",
		"index": "4050"
	}, {
		"id": "r4051_tw_microsoft_exchange.conf.json",
		"name": "microsoft exchange",
		"index": "4051"
	}, {
		"id": "r4060_tw_wordpress.conf.json",
		"name": "Adv WordPress",
		"index": "4060"
	}, {
		"id": "r4070_tw_joomla.conf.json",
		"name": "Adv Joomla",
		"index": "4070"
	}, {
		"id": "r4080_tw_vbulletin.conf.json",
		"name": "vBulletin",
		"index": "4080"
	}, {
		"id": "r4090_tw_citrix.conf.json",
		"name": "Citrix",
		"index": "4090"
	}, {
		"id": "r4100_tw_solarwinds_orion.conf.json",
		"name": "SolarWinds Orion",
		"index": "4100"
	}, {
		"id": "r4120_tw_apache.conf.json",
		"name": "Adv Apache Apps",
		"index": "4120"
	}, {
		"id": "r5010_scanner_detection.conf.json",
		"name": "Scanner Detection",
		"index": "5010"
	}, {
		"id": "r5020_http_protocol_violation.conf.json",
		"name": "HTTP Protocol Violation",
		"index": "5020"
	}, {
		"id": "r5021_http_attack.conf.json",
		"name": "HTTP Attack",
		"index": "5021"
	}, {
		"id": "r5030_local_file_inclusion.conf.json",
		"name": "Local File Inclusion (LFI)",
		"index": "5030"
	}, {
		"id": "r5031_remote_file_inclusion.conf.json",
		"name": "Remote File Inclusion (RFI)",
		"index": "5031"
	}, {
		"id": "r5032_remote_code_execution.conf.json",
		"name": "Remote Code Execution (RCE)",
		"index": "5032"
	}, {
		"id": "r5033_php_injection.conf.json",
		"name": "PHP Injection (PHPi)",
		"index": "5033"
	}, {
		"id": "r5034_nodejs_attack.conf.json",
		"name": "Nodejs Attack",
		"index": "5034"
	}, {
		"id": "r5040_cross_site_scripting.conf.json",
		"name": "Cross Site Scripting (XSS)",
		"index": "5040"
	}, {
		"id": "r5041_sql_injection.conf.json",
		"name": "SQL Injection (SQLi)",
		"index": "5041"
	}, {
		"id": "r5042_session_fixation.conf.json",
		"name": "Session Fixation",
		"index": "5042"
	}, {
		"id": "r5043_java_attack.conf.json",
		"name": "Java Attack",
		"index": "5043"
	}
]