Get Log Fields (RTLD Rate Limiting)

Retrieves the available set of log fields for RTLD Rate Limiting.

Request

Retrieve RTLD Rate Limiting log fields via the following request:

HTTP Method	Request URI
GET	https://api.vdms.io/rtld/v1/rl/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 /rl/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 Rate Limiting 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": "/rtld/v1/rl/fields",
	"@type": "Collection",
	"items": [{
			"category": "Response",
			"code": "timestamp",
			"name": "Timestamp"
		}, {
			"category": "Request Header",
			"code": "user_agent",
			"name": "User Agent"
		}, {
			"category": "Request",
			"code": "url",
			"name": "URL"
		}, {
			"category": "Security Configuration",
			"code": "scope_name",
			"name": "Scope Name"
		}, {
			"category": "Security Configuration",
			"code": "scope_id",
			"name": "Scope ID"
		}, {
			"category": "Request",
			"code": "method",
			"name": "Request Method"
		}, {
			"category": "Request Header",
			"code": "referer",
			"name": "Referer"
		}, {
			"category": "Security Configuration",
			"code": "limit_action_type",
			"name": "Rate Limiting Action Type"
		}, {
			"category": "Security Configuration",
			"code": "limit_action_percentage",
			"name": "Rate Limiting Action Percentage"
		}, {
			"category": "Security Configuration",
			"code": "limit_id",
			"name": "Rate Limiting Action Limit ID"
		}, {
			"category": "Security Configuration",
			"code": "limit_action_duration",
			"name": "Rate Limiting Action Duration"
		}, {
			"category": "Request Header",
			"code": "host",
			"name": "Host"
		}, {
			"category": "Client Geography",
			"code": "client_country_code",
			"name": "Country Code"
		}, {
			"category": "Client Network",
			"code": "client_ip",
			"name": "Client IP"
		}, {
			"category": "Client Geography",
			"code": "client_city",
			"name": "City Name"
		}, {
			"category": "General",
			"code": "account_number",
			"name": "Customer AN"
		}, {
			"category": "Client Geography",
			"code": "client_country",
			"name": "Country Name"
		}, {
			"category": "Security Configuration",
			"code": "limit_start_timestamp",
			"name": "Rate Limiting Action Start Epoch"
		}
	],
	"total_items": 18
}