Get Log Fields (RTLD WAF)

Retrieves the available set of log fields for RTLD WAF.

Request

Retrieve RTLD WAF log fields via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/rtld/v1/waf/fields

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

You may use either of the above endpoints. However, the API gateway endpoint requires oAuth 2.0 credentials.

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 elements:

Name	Data Type	Description
@id	String	Returns /waf/fields.
@type	String	Returns Collection.
items	Array of objects	Contains the available log fields.
total_items	Integer	Indicates the total number of log fields that were included in the response.

items Array

The items array describes each log field using the following properties:

Name	Data Type	Description
category	String	Identifies the log field's category.
code	String	Identifies a log field by its code name. Reference this code name when defining or retrieving a RTLD WAF profile.
name	String	Identifies a log field by its name.

Errors

The response body for an unsuccessful request will contain an error response that provides additional information.

Sample Request and Response (JSON)

A sample JSON request is shown below.

A sample JSON response is shown below.

{
	"@id": "/waf/fields",
	"@type": "Collection",
	"items": [{
			"category": "Client Geography",
			"code": "client_country_code",
			"name": "Country Code"
		}, {
			"category": "Client Geography",
			"code": "client_city",
			"name": "City Name"
		}, {
			"category": "Response",
			"code": "timestamp",
			"name": "Epoch Time"
		}, {
			"category": "Client Network",
			"code": "client_ip",
			"name": "Client IP"
		}, {
			"category": "Network",
			"code": "server_port",
			"name": "Server Port"
		}, {
			"category": "Request",
			"code": "url",
			"name": "URL"
		}, {
			"category": "Request Header",
			"code": "host",
			"name": "Host"
		}, {
			"category": "Request Header",
			"code": "user_agent",
			"name": "User Agent"
		}, {
			"category": "Request Header",
			"code": "referer",
			"name": "Referer"
		}, {
			"category": "General",
			"code": "account_number",
			"name": "Customer AN"
		}, {
			"category": "Request",
			"code": "uuid",
			"name": "Event ID"
		}, {
			"category": "Event",
			"code": "rule_message",
			"name": "Rule Message"
		}, {
			"category": "Event",
			"code": "rule_tags",
			"name": "Rule Tags"
		}, {
			"category": "Sub Event",
			"code": "sub_events_count",
			"name": "Sub Events Count"
		}, {
			"category": "Sub Event",
			"code": "sub_events",
			"name": "Sub Events"
		}, {
			"category": "Security Configuration",
			"code": "waf_instance_name",
			"name": "Instance Name"
		}, {
			"category": "Security Configuration",
			"code": "waf_profile_name",
			"name": "Profile Name"
		}, {
			"category": "Event",
			"code": "action_type",
			"name": "Action Type"
		}, {
			"category": "Security Configuration",
			"code": "waf_profile_type",
			"name": "Profile Type"
		}, {
			"category": "Client Geography",
			"code": "client_country",
			"name": "Country Name"
		}
	],
	"total_items": 20
}