Get Available Templates

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 templates that may be assigned to a profile.

Request

A request to retrieve templates is described below.

HTTP Method Request URI

GET

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

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

Name Data Type Description

id

String

Identifies a template by its system-defined ID.

  • System Templates: A set of predefined templates are provided to help you quickly set up a new profile. The system-defined ID for these templates will be set to a JSON file (e.g., 01_sample_2.json).
  • Custom Templates: A template is automatically created from each profile associated with your account. The system-defined ID for these templates will be the profile's system-defined ID.

    Retrieve a list of profiles and their system-defined IDs through the Get All Profiles endpoint.

name

String

Identifies a template 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/config/profiles/templates 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: 330

[{
		"id": "03_Trustwave_OWASP_Integrated.json",
		"name": "Trustwave OWASP Integrated Template"
	}, {
		"id": "02_OWASP.json",
		"name": "OWASP Template"
	}, {
		"id": "01_sample_2.json",
		"name": "Defend Best Practices Profile Template"
	}, {
		"id": "1234",
		"name": "Defend Best Practices Profile Template"
	}
]