Avi WafPolicyPSMGroup Object API

CLI ``` - configure wafpolicypsmgroup - show wafpolicypsmgroup ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /wafpolicypsmgroup
  2. post /wafpolicypsmgroup
  3. delete /wafpolicypsmgroup/{uuid}
  4. get /wafpolicypsmgroup/{uuid}
  5. patch /wafpolicypsmgroup/{uuid}
  6. put /wafpolicypsmgroup/{uuid}
Up
get /wafpolicypsmgroup
(wafpolicypsmgroupGet)

Consumes

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

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

WafPolicyPSMGroupApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "enable" : true,
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "is_learning_group" : true,
    "locations" : [ {
      "match" : {
        "path" : {
          "match_criteria" : "aeiou",
          "string_group_refs" : [ "aeiou" ],
          "match_str" : [ "aeiou" ],
          "match_case" : "aeiou"
        },
        "methods" : {
          "match_criteria" : "aeiou",
          "methods" : [ "aeiou" ]
        },
        "host" : {
          "match_criteria" : "aeiou",
          "value" : [ "aeiou" ],
          "match_case" : "aeiou"
        }
      },
      "name" : "aeiou",
      "description" : "aeiou",
      "index" : 123,
      "rules" : [ {
        "mode" : "aeiou",
        "rule_id" : "aeiou",
        "match_elements" : [ {
          "excluded" : true,
          "name" : "aeiou",
          "index" : 123,
          "sub_element" : "aeiou"
        } ],
        "match_value_pattern" : "aeiou",
        "enable" : true,
        "match_value_max_length" : 123,
        "name" : "aeiou",
        "description" : "aeiou",
        "index" : 123,
        "match_case" : "aeiou",
        "paranoia_level" : "aeiou"
      } ]
    } ],
    "hit_action" : "aeiou",
    "miss_action" : "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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WafPolicyPSMGroupApiResponse

401

log in failed

Up
post /wafpolicypsmgroup
(wafpolicypsmgroupPost)

Consumes

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

Request body

body (required)
Body Parameter — WafPolicyPSMGroup object creation

Return type

WafPolicyPSMGroup

Example data

Content-Type: application/json
{
  "enable" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "is_learning_group" : true,
  "locations" : [ {
    "match" : {
      "path" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ],
        "match_case" : "aeiou"
      },
      "methods" : {
        "match_criteria" : "aeiou",
        "methods" : [ "aeiou" ]
      },
      "host" : {
        "match_criteria" : "aeiou",
        "value" : [ "aeiou" ],
        "match_case" : "aeiou"
      }
    },
    "name" : "aeiou",
    "description" : "aeiou",
    "index" : 123,
    "rules" : [ {
      "mode" : "aeiou",
      "rule_id" : "aeiou",
      "match_elements" : [ {
        "excluded" : true,
        "name" : "aeiou",
        "index" : 123,
        "sub_element" : "aeiou"
      } ],
      "match_value_pattern" : "aeiou",
      "enable" : true,
      "match_value_max_length" : 123,
      "name" : "aeiou",
      "description" : "aeiou",
      "index" : 123,
      "match_case" : "aeiou",
      "paranoia_level" : "aeiou"
    } ]
  } ],
  "hit_action" : "aeiou",
  "miss_action" : "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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WafPolicyPSMGroup

401

log in failed

Up
delete /wafpolicypsmgroup/{uuid}
(wafpolicypsmgroupUuidDelete)

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:

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /wafpolicypsmgroup/{uuid}
(wafpolicypsmgroupUuidGet)

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:

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

WafPolicyPSMGroup

Example data

Content-Type: application/json
{
  "enable" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "is_learning_group" : true,
  "locations" : [ {
    "match" : {
      "path" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ],
        "match_case" : "aeiou"
      },
      "methods" : {
        "match_criteria" : "aeiou",
        "methods" : [ "aeiou" ]
      },
      "host" : {
        "match_criteria" : "aeiou",
        "value" : [ "aeiou" ],
        "match_case" : "aeiou"
      }
    },
    "name" : "aeiou",
    "description" : "aeiou",
    "index" : 123,
    "rules" : [ {
      "mode" : "aeiou",
      "rule_id" : "aeiou",
      "match_elements" : [ {
        "excluded" : true,
        "name" : "aeiou",
        "index" : 123,
        "sub_element" : "aeiou"
      } ],
      "match_value_pattern" : "aeiou",
      "enable" : true,
      "match_value_max_length" : 123,
      "name" : "aeiou",
      "description" : "aeiou",
      "index" : 123,
      "match_case" : "aeiou",
      "paranoia_level" : "aeiou"
    } ]
  } ],
  "hit_action" : "aeiou",
  "miss_action" : "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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WafPolicyPSMGroup

401

log in failed

Up
patch /wafpolicypsmgroup/{uuid}
(wafpolicypsmgroupUuidPatch)

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:

Request body

body (required)
Body Parameter — WafPolicyPSMGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

WafPolicyPSMGroup

Example data

Content-Type: application/json
{
  "enable" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "is_learning_group" : true,
  "locations" : [ {
    "match" : {
      "path" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ],
        "match_case" : "aeiou"
      },
      "methods" : {
        "match_criteria" : "aeiou",
        "methods" : [ "aeiou" ]
      },
      "host" : {
        "match_criteria" : "aeiou",
        "value" : [ "aeiou" ],
        "match_case" : "aeiou"
      }
    },
    "name" : "aeiou",
    "description" : "aeiou",
    "index" : 123,
    "rules" : [ {
      "mode" : "aeiou",
      "rule_id" : "aeiou",
      "match_elements" : [ {
        "excluded" : true,
        "name" : "aeiou",
        "index" : 123,
        "sub_element" : "aeiou"
      } ],
      "match_value_pattern" : "aeiou",
      "enable" : true,
      "match_value_max_length" : 123,
      "name" : "aeiou",
      "description" : "aeiou",
      "index" : 123,
      "match_case" : "aeiou",
      "paranoia_level" : "aeiou"
    } ]
  } ],
  "hit_action" : "aeiou",
  "miss_action" : "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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WafPolicyPSMGroup

401

log in failed

Up
put /wafpolicypsmgroup/{uuid}
(wafpolicypsmgroupUuidPut)

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:

Request body

body (required)
Body Parameter — WafPolicyPSMGroup object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

WafPolicyPSMGroup

Example data

Content-Type: application/json
{
  "enable" : true,
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "is_learning_group" : true,
  "locations" : [ {
    "match" : {
      "path" : {
        "match_criteria" : "aeiou",
        "string_group_refs" : [ "aeiou" ],
        "match_str" : [ "aeiou" ],
        "match_case" : "aeiou"
      },
      "methods" : {
        "match_criteria" : "aeiou",
        "methods" : [ "aeiou" ]
      },
      "host" : {
        "match_criteria" : "aeiou",
        "value" : [ "aeiou" ],
        "match_case" : "aeiou"
      }
    },
    "name" : "aeiou",
    "description" : "aeiou",
    "index" : 123,
    "rules" : [ {
      "mode" : "aeiou",
      "rule_id" : "aeiou",
      "match_elements" : [ {
        "excluded" : true,
        "name" : "aeiou",
        "index" : 123,
        "sub_element" : "aeiou"
      } ],
      "match_value_pattern" : "aeiou",
      "enable" : true,
      "match_value_max_length" : 123,
      "name" : "aeiou",
      "description" : "aeiou",
      "index" : 123,
      "match_case" : "aeiou",
      "paranoia_level" : "aeiou"
    } ]
  } ],
  "hit_action" : "aeiou",
  "miss_action" : "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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK WafPolicyPSMGroup

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. HostHdrMatch
  2. KeyValue
  3. MethodMatch
  4. PathMatch
  5. WafPSMLocation
  6. WafPSMLocationMatch
  7. WafPSMMatchElement
  8. WafPSMRule
  9. WafPolicyPSMGroup
  10. WafPolicyPSMGroupApiResponse

HostHdrMatch Up

match_case (optional)
String Case sensitivity to use for the match. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for the host header value match. Enum options - HDR_EXISTS, HDR_DOES_NOT_EXIST, HDR_BEGINS_WITH, HDR_DOES_NOT_BEGIN_WITH, HDR_CONTAINS, HDR_DOES_NOT_CONTAIN, HDR_ENDS_WITH, HDR_DOES_NOT_END_WITH, HDR_EQUALS, HDR_DOES_NOT_EQUAL.
value (optional)
array[String] String value(s) in the host header.

KeyValue Up

key
String Key.
value (optional)
String Value.

MethodMatch Up

match_criteria
String Criterion to use for HTTP method matching the method in the HTTP request. Enum options - IS_IN, IS_NOT_IN.
methods (optional)
array[String] Configure HTTP method(s). 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.

PathMatch Up

match_case (optional)
String Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE.
match_criteria
String Criterion to use for matching the path in the HTTP request URI. Enum options - BEGINS_WITH, DOES_NOT_BEGIN_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH, DOES_NOT_END_WITH, EQUALS, DOES_NOT_EQUAL, REGEX_MATCH, REGEX_DOES_NOT_MATCH.
match_str (optional)
array[String] String values.
string_group_refs (optional)
array[String] UUID of the string group(s). It is a reference to an object of type StringGroup.

WafPSMLocation Up

description (optional)
String Free-text comment about this location. Field introduced in 18.2.3.
index
Integer Location index, this is used to determine the order of the locations. Field introduced in 18.2.3. format: int32
match (optional)
WafPSMLocationMatch Apply these rules only if the request is matching this description. Field introduced in 18.2.3.
name
String User defined name for this location, it must be unique in the group. Field introduced in 18.2.3.
rules (optional)
array[WafPSMRule] A list of rules which should be applied on this location. Field introduced in 18.2.3.

WafPSMLocationMatch Up

host (optional)
HostHdrMatch Apply the rules only to requests that match the specified Host header. If this is not set, the host header will not be checked. Field introduced in 18.2.3.
methods (optional)
MethodMatch Apply the rules only to requests that have the specified methods. If this is not set, the method will not be checked. Field introduced in 18.2.3.
path (optional)
PathMatch Apply the rules only to requests that match the specified URI. If this is not set, the path will not be checked. Field introduced in 18.2.3.

WafPSMMatchElement Up

excluded (optional)
Boolean Mark this element excluded, like in '!ARGS password'. Field introduced in 18.2.3.
index
Integer Match_element index. Field introduced in 18.2.3. format: int32
name
String The variable specification. For example ARGS or REQUEST_COOKIES. This can be a scalar like PATH_INFO. Enum options - WAF_VARIABLE_ARGS, WAF_VARIABLE_ARGS_GET, WAF_VARIABLE_ARGS_POST, WAF_VARIABLE_ARGS_NAMES, WAF_VARIABLE_REQUEST_COOKIES, WAF_VARIABLE_QUERY_STRING, WAF_VARIABLE_REQUEST_BASENAME, WAF_VARIABLE_REQUEST_URI, WAF_VARIABLE_PATH_INFO. Field introduced in 18.2.3.
sub_element (optional)
String The name of the request collection element. This can be empty, if we address the whole collection or a scalar element. Field introduced in 18.2.3.

WafPSMRule Up

description (optional)
String Free-text comment about this rule. Field introduced in 18.2.3.
enable (optional)
Boolean Enable or disable this rule. Field introduced in 18.2.3.
index
Integer Rule index, this is used to determine the order of the rules. Field introduced in 18.2.3. format: int32
match_case (optional)
String The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Field introduced in 18.2.3.
match_elements (optional)
array[WafPSMMatchElement] The match elements, for example ARGS id or ARGS|!ARGS password. Field introduced in 18.2.3.
match_value_max_length (optional)
Integer The maximum allowed length of the match_value. If this is not set, the length will not be checked. Field introduced in 18.2.3. format: int32
match_value_pattern
String A regular expression which describes the expected value. Field introduced in 18.2.3.
mode (optional)
String WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Field introduced in 18.2.3.
name
String Name of the rule. Field introduced in 18.2.3.
paranoia_level (optional)
String WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Field introduced in 18.2.3.
rule_id
String Id field which is used for log and metric generation. This id must be unique for all rules in this group. Field introduced in 18.2.3.

WafPolicyPSMGroup Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
description (optional)
String Free-text comment about this group. Field introduced in 18.2.3.
enable (optional)
Boolean Enable or disable this WAF rule group. Field introduced in 18.2.3.
hit_action (optional)
String If a rule in this group matches the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_ALLOW_PARAMETER. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3.
is_learning_group (optional)
Boolean This field indicates that this group is used for learning. Field introduced in 18.2.3.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
locations (optional)
array[WafPSMLocation] Positive Security Model locations. These are used to partition the application name space. Field introduced in 18.2.3.
miss_action (optional)
String If a rule in this group does not match the match_value pattern, this action will be executed. Allowed actions are WAF_ACTION_NO_OP and WAF_ACTION_BLOCK. Enum options - WAF_ACTION_NO_OP, WAF_ACTION_BLOCK, WAF_ACTION_ALLOW_PARAMETER. Field introduced in 18.2.3.
name
String User defined name of the group. Field introduced in 18.2.3.
tenant_ref (optional)
String Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 18.2.3.
url (optional)
String url
uuid (optional)
String UUID of this object. Field introduced in 18.2.3.

WafPolicyPSMGroupApiResponse Up

count
Integer format: int32
results
next (optional)