Get Available Event Log Fields

WAF Insights does not support automation via our REST API web service. If you are currently using WAF Insights, upgrade your WAF solution to take advantage of our REST API.

Lists the available event log fields.

This endpoint only supports JSON.

Request

A request to retrieve a list of fields is described below.

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

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:

Name	Data Type	Description
fields	Array	This response parameter contains the set of available event log fields.
name	String	fields array Identifies an event log field by its name.
data_type	String	fields array Indicates the event log field's data type. Valid values are: date: Indicates that the event log field reports date/time in UTC. Format: YYYY-MM-DDThh:mm:ss:ffffffZ Example: 2015-06-30T20:42:09.330793Z The above value represents June 30th, 2015 at 8:42 p.m. UTC. For more information on date/time format, please refer to Report Date/Time Format. For more information on date/time format, please refer to Report Date/Time Format. epoch: Indicates that the event log field reports a date in Unix time (UTC). Example: 1435696928.9078219 The above value represents June 30th, 2015 at 8:42 p.m. UTC. ip: Indicates that the event log field reports an IP address (IPv4) in dot-decimal notation. Example: 101.100.20.200 string: Indicates that the event log field reports data as a string value.
description	String	fields array Provides a brief description of the event log field's purpose.

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.

{
	"fields" : [{
			"name" : "id",
			"data_type" : "string",
			"description" : "ID of event"
		}, {
			"name" : "Timestamp",
			"data_type" : "date",
			"description" : "timestamp of log entry as UTC timestamp"
		}, {
			"name" : "Rate Limiting Enforcement Rule ID",
			"data_type" : "string",
			"description" : "Rate Limiting Enforcement Rule ID"
		}, {
			"name" : "Rate Limiting Enforcement Duration",
			"data_type" : "string",
			"description" : "Rate Limiting Enforcement Duration"
		}, {
			"name" : "Rate Limiting Enforcement Percentage",
			"data_type" : "string",
			"description" : "Rate Limiting Enforcement Percentage"
		}, {
			"name" : "Rate Limiting Enforcement Type",
			"data_type" : "string",
			"description" : "Rate Limiting Enforcement type"
		}, {
			"name" : "Rate Limiting Enforcement Tuple ID",
			"data_type" : "string",
			"description" : "The internal ID of a tuple."
		}, {
			"name" : "Rate Limiting Enforcement Start Epoch",
			"data_type" : "string",
			"description" : "Rate Limiting Enforcement start time in seconds since epoch"
		}, {
			"name" : "File extension",
			"data_type" : "string",
			"description" : "File extension of the requested URI"
		}, {
			"name" : "Host",
			"data_type" : "string",
			"description" : "Hostname from request"
		}, {
			"name" : "Referer",
			"data_type" : "string",
			"description" : "Referer from request"
		}, {
			"name" : "Request Method",
			"data_type" : "string",
			"description" : "HTTP Request Method"
		}, {
			"name" : "Status",
			"data_type" : "string",
			"description" : "HTTP status code for the response"
		}, {
			"name" : "Epoch Time",
			"data_type" : "epoch",
			"description" : "time of log event as epoch UTC"
		}, {
			"name" : "URL",
			"data_type" : "string",
			"description" : "URL from request"
		}, {
			"name" : "User Agent",
			"data_type" : "string",
			"description" : "The clients user-agent"
		}, {
			"name" : "Client IP",
			"data_type" : "ip",
			"description" : "Client IP from Request"
		}, {
			"name" : "Country Code",
			"data_type" : "string",
			"description" : "Two letter country code"
		}
	]
}