BOTDEFENSE::cookie_status¶

Description¶

Returns the status of the Bot Defense cookie that is received on the request.

Note: In the previous version the returned status referred to both device_id and browser challenge. Now only the status of the browser cookie will be returned.

The returned value is one of the following strings:

not_received - the cookie did not appear in the request
valid - the cookie is valid and not expired
invalid - the cookie cannot be parsed; this could mean that it was modified by an attacker, or that it is older than two days, or due to a configuration change
expired - the cookie is valid, but is expired
valid_redirect_challenge - the cookie of the redirect was validated
renewal - browser challenge answer is about to expire

Syntax
BOTDEFENSE::cookie_status

Syntax¶

BOTDEFENSE::cookie_status

BOTDEFENSE::cookie_status¶

Return Value¶

A string signifying the status of the Bot Defense cookie.

Valid During¶

BOTDEFENSE_REQUEST, BOTDEFENSE_ACTION

Examples¶

# EXAMPLE: In case of an invalid cookie, send a message to High Speed Logging
 when BOTDEFENSE_REQUEST {
     if {[BOTDEFENSE::cookie_status] eq "invalid"} {
         HSL::send $hsl "invalid botdefense cookie from IP [IP::client_addr]"
     }
 }

Change Log¶

Introduced: BIGIP-12.1

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.