Avi WafProfile Object API

CLI ``` - configure wafprofile - show wafprofile ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 21.1.6

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /wafprofile
post /wafprofile
delete /wafprofile/{uuid}
get /wafprofile/{uuid}
patch /wafprofile/{uuid}
put /wafprofile/{uuid}

get /wafprofile

(wafprofileGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

WafProfileApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "description" : "aeiou",
    "files" : [ {
      "data" : "aeiou",
      "name" : "aeiou",
      "type" : "aeiou"
    } ],
    "markers" : [ {
      "values" : [ "aeiou" ],
      "key" : "aeiou"
    } ],
    "config" : {
      "client_nonfile_upload_max_body_size" : 123,
      "restricted_headers" : [ "aeiou" ],
      "response_hdr_default_action" : "aeiou",
      "xml_xxe_protection" : true,
      "allowed_methods" : [ "aeiou" ],
      "learning_params" : {
        "enable_per_uri_learning" : true,
        "min_hits_to_learn" : 123456789,
        "max_uris" : 123,
        "update_interval" : 123,
        "sampling_percent" : 123,
        "max_params" : 123
      },
      "buffer_response_body_for_inspection" : true,
      "send_status_header" : true,
      "status_header_name" : "aeiou",
      "min_confidence" : "aeiou",
      "cookie_format_version" : 123,
      "request_hdr_default_action" : "aeiou",
      "argument_separator" : "aeiou",
      "client_file_upload_max_body_size" : 123,
      "enable_auto_rule_updates" : true,
      "client_request_max_body_size" : 123,
      "ignore_incomplete_request_body_error" : true,
      "allowed_http_versions" : [ "aeiou" ],
      "regex_match_limit" : 123,
      "response_body_default_action" : "aeiou",
      "content_type_mappings" : [ {
        "content_type" : "aeiou",
        "request_body_parser" : "aeiou"
      } ],
      "max_execution_time" : 123,
      "confidence_override" : {
        "confid_probable_value" : 123,
        "confid_low_value" : 123,
        "confid_very_high_value" : 123,
        "confid_high_value" : 123
      },
      "server_response_max_body_size" : 123,
      "restricted_extensions" : [ "aeiou" ],
      "request_body_default_action" : "aeiou",
      "allowed_request_content_types" : [ "aeiou" ],
      "regex_recursion_limit" : 123,
      "static_extensions" : [ "aeiou" ],
      "status_code_for_rejected_requests" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK WafProfileApiResponse

401

post /wafprofile

(wafprofilePost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — WafProfile object creation

Return type

WafProfile

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "description" : "aeiou",
  "files" : [ {
    "data" : "aeiou",
    "name" : "aeiou",
    "type" : "aeiou"
  } ],
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "config" : {
    "client_nonfile_upload_max_body_size" : 123,
    "restricted_headers" : [ "aeiou" ],
    "response_hdr_default_action" : "aeiou",
    "xml_xxe_protection" : true,
    "allowed_methods" : [ "aeiou" ],
    "learning_params" : {
      "enable_per_uri_learning" : true,
      "min_hits_to_learn" : 123456789,
      "max_uris" : 123,
      "update_interval" : 123,
      "sampling_percent" : 123,
      "max_params" : 123
    },
    "buffer_response_body_for_inspection" : true,
    "send_status_header" : true,
    "status_header_name" : "aeiou",
    "min_confidence" : "aeiou",
    "cookie_format_version" : 123,
    "request_hdr_default_action" : "aeiou",
    "argument_separator" : "aeiou",
    "client_file_upload_max_body_size" : 123,
    "enable_auto_rule_updates" : true,
    "client_request_max_body_size" : 123,
    "ignore_incomplete_request_body_error" : true,
    "allowed_http_versions" : [ "aeiou" ],
    "regex_match_limit" : 123,
    "response_body_default_action" : "aeiou",
    "content_type_mappings" : [ {
      "content_type" : "aeiou",
      "request_body_parser" : "aeiou"
    } ],
    "max_execution_time" : 123,
    "confidence_override" : {
      "confid_probable_value" : 123,
      "confid_low_value" : 123,
      "confid_very_high_value" : 123,
      "confid_high_value" : 123
    },
    "server_response_max_body_size" : 123,
    "restricted_extensions" : [ "aeiou" ],
    "request_body_default_action" : "aeiou",
    "allowed_request_content_types" : [ "aeiou" ],
    "regex_recursion_limit" : 123,
    "static_extensions" : [ "aeiou" ],
    "status_code_for_rejected_requests" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK WafProfile

401

delete /wafprofile/{uuid}

(wafprofileUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /wafprofile/{uuid}

(wafprofileUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

WafProfile

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "description" : "aeiou",
  "files" : [ {
    "data" : "aeiou",
    "name" : "aeiou",
    "type" : "aeiou"
  } ],
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "config" : {
    "client_nonfile_upload_max_body_size" : 123,
    "restricted_headers" : [ "aeiou" ],
    "response_hdr_default_action" : "aeiou",
    "xml_xxe_protection" : true,
    "allowed_methods" : [ "aeiou" ],
    "learning_params" : {
      "enable_per_uri_learning" : true,
      "min_hits_to_learn" : 123456789,
      "max_uris" : 123,
      "update_interval" : 123,
      "sampling_percent" : 123,
      "max_params" : 123
    },
    "buffer_response_body_for_inspection" : true,
    "send_status_header" : true,
    "status_header_name" : "aeiou",
    "min_confidence" : "aeiou",
    "cookie_format_version" : 123,
    "request_hdr_default_action" : "aeiou",
    "argument_separator" : "aeiou",
    "client_file_upload_max_body_size" : 123,
    "enable_auto_rule_updates" : true,
    "client_request_max_body_size" : 123,
    "ignore_incomplete_request_body_error" : true,
    "allowed_http_versions" : [ "aeiou" ],
    "regex_match_limit" : 123,
    "response_body_default_action" : "aeiou",
    "content_type_mappings" : [ {
      "content_type" : "aeiou",
      "request_body_parser" : "aeiou"
    } ],
    "max_execution_time" : 123,
    "confidence_override" : {
      "confid_probable_value" : 123,
      "confid_low_value" : 123,
      "confid_very_high_value" : 123,
      "confid_high_value" : 123
    },
    "server_response_max_body_size" : 123,
    "restricted_extensions" : [ "aeiou" ],
    "request_body_default_action" : "aeiou",
    "allowed_request_content_types" : [ "aeiou" ],
    "regex_recursion_limit" : 123,
    "static_extensions" : [ "aeiou" ],
    "status_code_for_rejected_requests" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK WafProfile

401

patch /wafprofile/{uuid}

(wafprofileUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — WafProfile object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

WafProfile

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "description" : "aeiou",
  "files" : [ {
    "data" : "aeiou",
    "name" : "aeiou",
    "type" : "aeiou"
  } ],
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "config" : {
    "client_nonfile_upload_max_body_size" : 123,
    "restricted_headers" : [ "aeiou" ],
    "response_hdr_default_action" : "aeiou",
    "xml_xxe_protection" : true,
    "allowed_methods" : [ "aeiou" ],
    "learning_params" : {
      "enable_per_uri_learning" : true,
      "min_hits_to_learn" : 123456789,
      "max_uris" : 123,
      "update_interval" : 123,
      "sampling_percent" : 123,
      "max_params" : 123
    },
    "buffer_response_body_for_inspection" : true,
    "send_status_header" : true,
    "status_header_name" : "aeiou",
    "min_confidence" : "aeiou",
    "cookie_format_version" : 123,
    "request_hdr_default_action" : "aeiou",
    "argument_separator" : "aeiou",
    "client_file_upload_max_body_size" : 123,
    "enable_auto_rule_updates" : true,
    "client_request_max_body_size" : 123,
    "ignore_incomplete_request_body_error" : true,
    "allowed_http_versions" : [ "aeiou" ],
    "regex_match_limit" : 123,
    "response_body_default_action" : "aeiou",
    "content_type_mappings" : [ {
      "content_type" : "aeiou",
      "request_body_parser" : "aeiou"
    } ],
    "max_execution_time" : 123,
    "confidence_override" : {
      "confid_probable_value" : 123,
      "confid_low_value" : 123,
      "confid_very_high_value" : 123,
      "confid_high_value" : 123
    },
    "server_response_max_body_size" : 123,
    "restricted_extensions" : [ "aeiou" ],
    "request_body_default_action" : "aeiou",
    "allowed_request_content_types" : [ "aeiou" ],
    "regex_recursion_limit" : 123,
    "static_extensions" : [ "aeiou" ],
    "status_code_for_rejected_requests" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK WafProfile

401

put /wafprofile/{uuid}

(wafprofileUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — WafProfile object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

WafProfile

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "description" : "aeiou",
  "files" : [ {
    "data" : "aeiou",
    "name" : "aeiou",
    "type" : "aeiou"
  } ],
  "markers" : [ {
    "values" : [ "aeiou" ],
    "key" : "aeiou"
  } ],
  "config" : {
    "client_nonfile_upload_max_body_size" : 123,
    "restricted_headers" : [ "aeiou" ],
    "response_hdr_default_action" : "aeiou",
    "xml_xxe_protection" : true,
    "allowed_methods" : [ "aeiou" ],
    "learning_params" : {
      "enable_per_uri_learning" : true,
      "min_hits_to_learn" : 123456789,
      "max_uris" : 123,
      "update_interval" : 123,
      "sampling_percent" : 123,
      "max_params" : 123
    },
    "buffer_response_body_for_inspection" : true,
    "send_status_header" : true,
    "status_header_name" : "aeiou",
    "min_confidence" : "aeiou",
    "cookie_format_version" : 123,
    "request_hdr_default_action" : "aeiou",
    "argument_separator" : "aeiou",
    "client_file_upload_max_body_size" : 123,
    "enable_auto_rule_updates" : true,
    "client_request_max_body_size" : 123,
    "ignore_incomplete_request_body_error" : true,
    "allowed_http_versions" : [ "aeiou" ],
    "regex_match_limit" : 123,
    "response_body_default_action" : "aeiou",
    "content_type_mappings" : [ {
      "content_type" : "aeiou",
      "request_body_parser" : "aeiou"
    } ],
    "max_execution_time" : 123,
    "confidence_override" : {
      "confid_probable_value" : 123,
      "confid_low_value" : 123,
      "confid_very_high_value" : 123,
      "confid_high_value" : 123
    },
    "server_response_max_body_size" : 123,
    "restricted_extensions" : [ "aeiou" ],
    "request_body_default_action" : "aeiou",
    "allowed_request_content_types" : [ "aeiou" ],
    "regex_recursion_limit" : 123,
    "static_extensions" : [ "aeiou" ],
    "status_code_for_rejected_requests" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK WafProfile

401

Models

[ Jump to Methods ]

AppLearningConfidenceOverride
AppLearningParams
ConfigPbAttributes
KeyValue
RoleFilterMatchLabel
WafConfig
WafContentTypeMapping
WafDataFile
WafProfile
WafProfileApiResponse

AppLearningConfidenceOverride Up

confid_high_value (optional)

Integer Confidence threshold for label CONFIDENCE_HIGH. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

confid_low_value (optional)

Integer Confidence threshold for label CONFIDENCE_LOW. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

confid_probable_value (optional)

Integer Confidence threshold for label CONFIDENCE_PROBABLE. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

confid_very_high_value (optional)

Integer Confidence threshold for label CONFIDENCE_VERY_HIGH. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

AppLearningParams Up

enable_per_uri_learning (optional)

Boolean Learn the params per URI path. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

max_params (optional)

Integer Maximum number of params programmed for an application. Allowed values are 10-1000. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

max_uris (optional)

Integer Maximum number of URI paths programmed for an application. Allowed values are 10-10000. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

min_hits_to_learn (optional)

Long Minimum number of occurances required for a Param to qualify for learning. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

sampling_percent (optional)

Integer Percent of the requests subjected to Application learning. Allowed values are 1-100. Field introduced in 18.2.3. Unit is PERCENT. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

update_interval (optional)

Integer Frequency with which SE publishes Application learning data to controller. Allowed values are 1-60. Field introduced in 18.2.3. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

ConfigPbAttributes Up

version (optional)

Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

KeyValue Up

key

String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

value (optional)

String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

RoleFilterMatchLabel Up

key

String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

values (optional)

array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

WafConfig Up

allowed_http_versions (optional)

array[String] WAF allowed HTTP Versions. Enum options - ZERO_NINE, ONE_ZERO, ONE_ONE, TWO_ZERO. Field introduced in 17.2.1. Maximum of 8 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

allowed_methods (optional)

array[String] WAF allowed HTTP methods. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

allowed_request_content_types (optional)

array[String] WAF allowed Content Types. Field deprecated in 21.1.3. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

argument_separator (optional)

String Argument seperator. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

buffer_response_body_for_inspection (optional)

Boolean Enable to buffer response body for inspection. Field deprecated in 18.2.2. Field introduced in 17.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

client_file_upload_max_body_size (optional)

Integer Maximum size for the client request body for file uploads. Allowed values are 1-32768. Field deprecated in 18.1.5. Field introduced in 17.2.1. Unit is KB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

client_nonfile_upload_max_body_size (optional)

Integer Maximum size for the client request body for non-file uploads. Allowed values are 1-32768. Field deprecated in 18.1.5. Field introduced in 17.2.1. Unit is KB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

client_request_max_body_size (optional)

Integer Maximum size for the client request body scanned by WAF. Allowed values are 1-32768. Field introduced in 18.1.5, 18.2.1. Unit is KB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

confidence_override (optional)

AppLearningConfidenceOverride Deprecated (Moved to WafPolicy). Configure thresholds for confidence labels. Field deprecated in 20.1.1. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

content_type_mappings (optional)

array[WafContentTypeMapping] WAF Content-Types and their request body parsers. Use this field to configure which Content-Types should be handled by WAF and which parser should be used. All Content-Types here are treated as 'allowed'. The order of entries matters. If the request's Content-Type matches an entry, its request body parser will run and no other parser will be invoked. Field introduced in 21.1.3. Maximum of 256 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

cookie_format_version (optional)

Integer 0 For Netscape Cookies. 1 For version 1 cookies. Allowed values are 0-1. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

enable_auto_rule_updates (optional)

Boolean Deprecated (Moved to WafPolicy). Enable Application Learning based rule updates on the WAF Profile. Rules will be programmed in dedicated WAF learning group. Field deprecated in 20.1.1. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

ignore_incomplete_request_body_error (optional)

Boolean Ignore request body parsing errors due to partial scanning. Field introduced in 18.1.5, 18.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

learning_params (optional)

AppLearningParams Deprecated (Moved to WafPolicy). Parameters for tuning Application learning. Field deprecated in 20.1.1. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

max_execution_time (optional)

Integer The maximum period of time WAF processing is allowed to take for a single request. A value of 0 (zero) means no limit and should not be chosen in production deployments. It is only used for exceptional situations where crashes of se_dp processes are acceptable. The behavior of the system if this time is exceeded depends on two other configuration settings, the WAF policy mode and the WAF failure mode. In WAF policy mode 'Detection', the request is allowed and flagged for both failure mode 'Closed' and 'Open'. In enforcement node, 'Closed' means the request is rejected, 'Open' means the request is allowed and flagged. Irrespective of these settings, no subsequent WAF rules of this or other phases will be executed once the maximum execution time has been exceeded. Allowed values are 0-5000. Field introduced in 17.2.12, 18.1.2. Unit is MILLISECONDS. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

min_confidence (optional)

String Deprecated (Moved to WafPolicy) Minimum confidence label required for auto rule updates. Enum options - CONFIDENCE_VERY_HIGH, CONFIDENCE_HIGH, CONFIDENCE_PROBABLE, CONFIDENCE_LOW, CONFIDENCE_NONE. Field deprecated in 20.1.1. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

regex_match_limit (optional)

Integer Limit CPU utilization for each regular expression match when processing rules. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

regex_recursion_limit (optional)

Integer Limit depth of recursion for each regular expression match when processing rules. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

request_body_default_action

String WAF default action for Request Body Phase. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

request_hdr_default_action

String WAF default action for Request Header Phase. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

response_body_default_action

String WAF default action for Response Body Phase. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

response_hdr_default_action

String WAF default action for Response Header Phase. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

restricted_extensions (optional)

array[String] WAF Restricted File Extensions. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

restricted_headers (optional)

array[String] WAF Restricted HTTP Headers. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

send_status_header (optional)

Boolean Whether or not to send WAF status in a request header to pool servers. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

server_response_max_body_size (optional)

Integer Maximum size for response body scanned by WAF. Allowed values are 1-32768. Field introduced in 17.2.1. Unit is KB. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

static_extensions (optional)

array[String] WAF Static File Extensions. GET and HEAD requests with no query args and one of these extensions are allowed and not checked by the ruleset. Field introduced in 17.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

status_code_for_rejected_requests (optional)

String HTTP status code used by WAF Positive Security Model when rejecting a request. Enum options - HTTP_RESPONSE_CODE_0, HTTP_RESPONSE_CODE_100, HTTP_RESPONSE_CODE_101, HTTP_RESPONSE_CODE_200, HTTP_RESPONSE_CODE_201, HTTP_RESPONSE_CODE_202, HTTP_RESPONSE_CODE_203, HTTP_RESPONSE_CODE_204, HTTP_RESPONSE_CODE_205, HTTP_RESPONSE_CODE_206, HTTP_RESPONSE_CODE_300, HTTP_RESPONSE_CODE_301, HTTP_RESPONSE_CODE_302, HTTP_RESPONSE_CODE_303, HTTP_RESPONSE_CODE_304, HTTP_RESPONSE_CODE_305, HTTP_RESPONSE_CODE_307, HTTP_RESPONSE_CODE_400, HTTP_RESPONSE_CODE_401, HTTP_RESPONSE_CODE_402, HTTP_RESPONSE_CODE_403, HTTP_RESPONSE_CODE_404, HTTP_RESPONSE_CODE_405, HTTP_RESPONSE_CODE_406, HTTP_RESPONSE_CODE_407, HTTP_RESPONSE_CODE_408, HTTP_RESPONSE_CODE_409, HTTP_RESPONSE_CODE_410, HTTP_RESPONSE_CODE_411, HTTP_RESPONSE_CODE_412, HTTP_RESPONSE_CODE_413, HTTP_RESPONSE_CODE_414, HTTP_RESPONSE_CODE_415, HTTP_RESPONSE_CODE_416, HTTP_RESPONSE_CODE_417, HTTP_RESPONSE_CODE_426, HTTP_RESPONSE_CODE_470, HTTP_RESPONSE_CODE_475, HTTP_RESPONSE_CODE_500, HTTP_RESPONSE_CODE_501, HTTP_RESPONSE_CODE_502, HTTP_RESPONSE_CODE_503, HTTP_RESPONSE_CODE_504, HTTP_RESPONSE_CODE_505. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

status_header_name (optional)

String The name of the request header indicating WAF evaluation status to pool servers. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

xml_xxe_protection (optional)

Boolean Block or flag XML requests referring to External Entities. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

WafContentTypeMapping Up

content_type

String Request Content-Type. When it is equal to request Content-Type header value, the specified request_body_parser is used. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

request_body_parser

String Request body parser. Enum options - WAF_REQUEST_PARSER_URLENCODED, WAF_REQUEST_PARSER_MULTIPART, WAF_REQUEST_PARSER_JSON, WAF_REQUEST_PARSER_XML, WAF_REQUEST_PARSER_HANDLE_AS_STRING, WAF_REQUEST_PARSER_DO_NOT_PARSE. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

WafDataFile Up

data

String Stringified WAF File Data. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

name

String WAF Data File Name. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

type (optional)

String WAF data file type. Enum options - WAF_DATAFILE_PM_FROM_FILE, WAF_DATAFILE_DTD, WAF_DATAFILE_XSD. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

WafProfile Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

config

WafConfig Config params for WAF. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

configpb_attributes (optional)

ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

description (optional)

String Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

files (optional)

array[WafDataFile] List of Data Files Used for WAF Rules. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

labels (optional)

array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

markers (optional)

array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

name

String Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

tenant_ref (optional)

String It is a reference to an object of type Tenant. Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String url

uuid (optional)

String Field introduced in 17.2.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

WafProfileApiResponse Up

count

Integer format: int32

results

array[WafProfile]

next (optional)

String

Avi WafProfile Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents