Get Available Action Types - Deprecated

This article explains the legacy version of Rate Limiting 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.

This deprecated endpoint was discontinuedIdentifies an endpoint that is no longer in service. This type of endpoint should not be used. All scripts that include this type of endpoint must be updated to use a different endpoint. on 12/9/2019. If you have not already updated your scripts and applications to leverage the Get Configuration (Version 1.0) and Update Configuration (Version 1.0) endpoints, then we strongly encourage you to do so immediately.

Describes each available action type. An action type determines the type of action that will take place on rate limited requests.

This endpoint only supports JSON.

Request

A request to retrieve the set of available action types is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/defend/rate_limiting/config_options/enforcements

Define the following term 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 available action type returned by this endpoint:

Name	Data Type	Description
friendly_name	String	Identifies an action type by its name.
type	String	Identifies an action type by its technical name.
help	String	Provides a brief description of the action type’s purpose.
parameters	Array	This response parameter describes each setting associated with a specific action type. The set of settings included in this response parameter varies by action type.
name	String	parameters array Identifies a setting by its internal name.
base64_encoded	Boolean	parameters array Indicates whether the value associated with this setting is Base64 encoded. If this response parameter is set to "true," then this setting's value is Base64 encoded.
default	Integer	parameters array Indicates the setting's default value.
required	Boolean	parameters array Indicates whether this setting must be defined when the parent action type is assigned to a rule.
friendly_name	String	parameters array Identifies a setting by its name.
type	String	parameters array Indicates the setting's data type. Valid values are: int: Integer string: String dict: Dictionary (Unordered key:value pairs)
help	String	parameters array Provides a brief description for the setting.

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.

A sample JSON response is shown below.

[{
		"friendly_name" : "Redirect (HTTP 302)",
		"type" : "redirect-302",
		"help" : "Sends the client an HTTP 302 redirect to the given URL.",
		"parameters" : [{
				"type" : "string",
				"required" : true,
				"friendly_name" : "URL",
				"name" : "url",
				"help" : "The URL to redirect to."
			}
		]
	}, {
		"friendly_name" : "Custom Response",
		"type" : "custom-response",
		"help" : "Sends the client a custom response.",
		"parameters" : [{
				"name" : "response_body_base64",
				"base64_encoded" : true,
				"required" : false,
				"friendly_name" : "Response Body",
				"type" : "string",
				"help" : "The response to send the client."
			}, {
				"name" : "status",
				"default" : 404,
				"required" : true,
				"friendly_name" : "HTTP Status Code",
				"type" : "int",
				"help" : "The HTTP Status Code to send the client (e.g. 404)"
			}, {
				"type" : "dict",
				"required" : false,
				"friendly_name" : "Custom Response Headers",
				"name" : "response_headers",
				"help" : "A set of custom headers to send in the response, \"header-name\": \"value\""
			}
		]
	}, {
		"friendly_name" : "Drop Request",
		"type" : "drop-request",
		"help" : "Sends the client a 503 and Retry-After header.",
		"parameters" : []
	}, {
		"friendly_name" : "Alert Only",
		"type" : "nop",
		"help" : "Take no action.",
		"parameters" : []
	}
]