Imperva API Security

Third Party

Configuration

config
Hide Child Parameters
destination_addrstringrequired

Destination address of the API security receiver.
This can be an IP address or domain name, for example logconsumer.myapisec.mydomain.

destination_portnumber

Destination port of the API security receiver.

Default:8080

connection_typestring

The connection protocol to use.

Default:tcp

methodstring

The request method to use.

Default:POST

max_body_sizenumber

Maximum payload body size to capture, in bytes.

Default:1048576

sslboolean

Whether or not to use an TLS/SSL tunnel to send API traffic capture to the destination.

Default:false

request_body_flagboolean

Determines whether to send the request body payload to the destination.

Set to false to disable. Use only for debugging purposes.
API security will not fully function without inspection of the request body payload.

Default:true

response_body_flagboolean

Determines whether to send the response body payload to the destination.

Set to false to disable. Use only for debugging purposes.
API security will not fully function without inspection of the response body payload.

Default:true

retry_countnumber

Number of retries if sending the API call capture fails. No retry by default.

Default:0

queue_sizenumber

Number of API logs to keep in the queue for retries. Default is 1, meaning no retries.
Set to a number larger than 1 to enable retries.

Default:1

flush_timeoutnumber

Number of seconds to wait before flushing the queue.

Default:2

timeoutnumber

Number of milliseconds to keep a single connection open to the destination.

Default:6000000

protocolsarray[string]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Allowed values:httphttps

Default:http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!