Add Profile by Template

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.

WAF Essential cannot be configured via our APIs. However, you may leverage our APIs to retrieve WAF and Rate Limiting event log data.

Creates a WAF profile based on a specific template.

Use the Update Profile endpoint to fine-tune the configuration of a profile created through this endpoint.

Request

A request to create a profile is described below.

HTTP Method	Request URI
POST	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/waf/config/profiles/bytemplate

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

Pass the following request body parameters:

Name	Data Type	Description
name Required	String	Defines the name that will be assigned to the new profile.
template_id Required	String	Identifies a template by its system-defined ID. This template determines the configuration that will be applied to the new profile. Use the Get Available Templates endpoint to retrieve a list of templates and their IDs. Use the Get Template endpoint to view a template's configuration.

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:

Name	Data Type	Description
id	String	Identifies the new WAF profile by its system-defined ID.
status	String	Returns "success" when a WAF profile is created.
success	Boolean	Indicates whether the WAF profile was created. Valid values are: true false

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.

{
	"name" : "Site C Profile",
	"template_id" : "03_Trustwave_OWASP_Integrated.json"
}

A sample JSON response is shown below.

{
	"id": "41abd111-2fcd-4333-8cfb-1a2bcd34e45f",
	"status": "success",
	"success": true
}