Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WafLog

A list of Web Application Firewall log entries. Each entry is a JSON object, including a timestamp property and other fields varying based on log type. Logs record what rules and countermeasures are triggered by requests and are used as a basis to move request handling into block mode. For more information about WAF logs, see Logs.

Properties

Optional accessRuleKey

accessRuleKey: undefined | string

The {@code AccessRule} key that matched the request. For more information about access rules, see {@code UpdateAccessRules}.

Optional action

action: undefined | string

The action taken on the request, either {@code ALLOW}, {@code DETECT}, or {@code BLOCK}.

Optional addressRateLimitingKey

addressRateLimitingKey: undefined | string

The {@code AddressRateLimiting} key that matched the request. For more information about address rate limiting, see {@code UpdateWafAddressRateLimiting}.

Optional captchaAction

captchaAction: undefined | string

The CAPTCHA action taken on the request, {@code ALLOW} or {@code BLOCK}. For more information about CAPTCHAs, see {@code UpdateCaptchas}.

Optional captchaExpected

captchaExpected: undefined | string

The CAPTCHA challenge answer that was expected.

Optional captchaFailCount

captchaFailCount: undefined | string

The number of times the CAPTCHA challenge was failed.

Optional captchaReceived

captchaReceived: undefined | string

The CAPTCHA challenge answer that was received.

Optional clientAddress

clientAddress: undefined | string

The IPv4 address of the requesting client.

Optional countryCode

countryCode: undefined | string

ISO 3166-1 alpha-2 code of the country from which the request originated. For a list of codes, see ISO's website.

Optional countryName

countryName: undefined | string

The name of the country where the request originated.

Optional device

device: undefined | string

The type of device that the request was made from.

Optional domain

domain: undefined | string

The {@code Host} header data of the request.

Optional fingerprint

fingerprint: undefined | string

The hashed signature of the device's fingerprint. For more information, see {@code DeviceFingerPrintChallenge}.

Optional httpHeaders

httpHeaders: undefined | object

The map of the request's header names to their respective values.

Optional httpMethod

httpMethod: undefined | string

The HTTP method of the request.

Optional incidentKey

incidentKey: undefined | string

The incident key of a request. An incident key is generated for each request processed by the Web Application Firewall and is used to idenitfy blocked requests in applicable logs.

Optional logType

logType: undefined | string

The type of log of the request. For more about log types, see Logs.

Optional originAddress

originAddress: undefined | string

The address of the origin server where the request was sent.

Optional originResponseTime

originResponseTime: undefined | string

The amount of time it took the origin server to respond to the request, in seconds.

Optional protectionRuleDetections

protectionRuleDetections: undefined | object

A map of protection rule keys to detection message details. Detections are requests that matched the criteria of a protection rule but the rule's action was set to {@code DETECT}.

Optional referrer

referrer: undefined | string

The {@code Referrer} header value of the request.

Optional requestHeaders

requestHeaders: undefined | object

A map of header names to values of the request sent to the origin, including any headers appended by the Web Application Firewall.

Optional requestUrl

requestUrl: undefined | string

The path and query string of the request.

Optional responseCode

responseCode: undefined | number

The status code of the response. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional responseSize

responseSize: undefined | number

The size in bytes of the response. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional threatFeedKey

threatFeedKey: undefined | string

The {@code ThreatFeed} key that matched the request. For more information about threat feeds, see {@code UpdateThreatFeeds}.

Optional timestamp

timestamp: Date

The date and time the Web Application Firewall processed the request and logged it.

Optional userAgent

userAgent: undefined | string

The value of the request's {@code User-Agent} header field.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: WafLog): object

getJsonObj

  • getJsonObj(obj: WafLog): object