This article explains the legacy version of
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.
Lists the available criteria that may be used to group similar requests. The rate limiting policy may be applied independently to each group identified by the system.
This endpoint only supports JSON.
A request to retrieve group types is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.transactcdn.com/v2/mcc/customers/AccountNumber/defend/rate_limiting/config_options/dimensions |
Define the following term when submitting the above request:
Description | |
---|---|
Required |
|
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters for each available group type:
Name | Data Type | Description |
---|---|---|
friendly_name |
String |
Identifies a group type by its name. |
name |
String |
Identifies a group type by its technical name. |
help |
String |
Provides a brief description of the group type's purpose. |
The response body for an unsuccessful request will contain an error response that provides additional information.
A sample JSON request is shown below.
GET https://api.transactcdn.com/v2/mcc/customers/0001/defend/rate_limiting/config_options/dimensions 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: 267
[{ "friendly_name" : "IP Address", "name" : "IP", "help" : "The IP address of the client making a request." }, { "friendly_name" : "User Agent", "name" : "USER_AGENT", "help" : "The User Agent of the client making a request." } ]