Avi WafApplicationSignatureProvider Object API

CLI ``` - show wafapplicationsignatureprovider - configure wafapplicationsignatureprovider ```

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

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

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

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

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

get /wafapplicationsignatureprovider

(wafapplicationsignatureproviderGet)

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

WafApplicationSignatureProviderApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "last_successful_check_for_updates" : "",
    "ruleset_version" : "aeiou",
    "available_applications" : [ {
      "application" : "aeiou",
      "last_changed_ruleset_version" : "aeiou",
      "number_of_rules" : 123
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "service_status" : {
      "error" : "aeiou",
      "last_successful_update_check" : "",
      "upstream_sync_timestamp" : ""
    },
    "last_failed_check_for_updates" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "uuid" : "aeiou",
    "last_check_for_updates_error" : "aeiou",
    "signatures" : [ {
      "mode" : "aeiou",
      "phase" : "aeiou",
      "rule_id" : "aeiou",
      "force_detection" : true,
      "enable" : true,
      "is_sensitive" : true,
      "name" : "aeiou",
      "index" : 123,
      "rule" : "aeiou",
      "exclude_list" : [ {
        "client_subnet" : {
          "ip_addr" : {
            "addr" : "aeiou",
            "type" : "aeiou"
          },
          "mask" : 123
        },
        "match_element" : "aeiou",
        "uri_path" : "aeiou",
        "uri_match_criteria" : "",
        "match_element_criteria" : {
          "match_op" : "aeiou",
          "match_case" : "aeiou"
        },
        "description" : "aeiou"
      } ],
      "tags" : [ "aeiou" ]
    } ],
    "url" : "aeiou",
    "_last_modified" : "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 WafApplicationSignatureProviderApiResponse

401

post /wafapplicationsignatureprovider

(wafapplicationsignatureproviderPost)

Consumes

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

application/json

Request body

body (required)

Body Parameter — WafApplicationSignatureProvider object creation

Return type

WafApplicationSignatureProvider

Example data

Content-Type: application/json

{
  "last_successful_check_for_updates" : "",
  "ruleset_version" : "aeiou",
  "available_applications" : [ {
    "application" : "aeiou",
    "last_changed_ruleset_version" : "aeiou",
    "number_of_rules" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "service_status" : {
    "error" : "aeiou",
    "last_successful_update_check" : "",
    "upstream_sync_timestamp" : ""
  },
  "last_failed_check_for_updates" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "uuid" : "aeiou",
  "last_check_for_updates_error" : "aeiou",
  "signatures" : [ {
    "mode" : "aeiou",
    "phase" : "aeiou",
    "rule_id" : "aeiou",
    "force_detection" : true,
    "enable" : true,
    "is_sensitive" : true,
    "name" : "aeiou",
    "index" : 123,
    "rule" : "aeiou",
    "exclude_list" : [ {
      "client_subnet" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "match_element" : "aeiou",
      "uri_path" : "aeiou",
      "uri_match_criteria" : "",
      "match_element_criteria" : {
        "match_op" : "aeiou",
        "match_case" : "aeiou"
      },
      "description" : "aeiou"
    } ],
    "tags" : [ "aeiou" ]
  } ],
  "url" : "aeiou",
  "_last_modified" : "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 WafApplicationSignatureProvider

401

delete /wafapplicationsignatureprovider/{uuid}

(wafapplicationsignatureproviderUuidDelete)

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 /wafapplicationsignatureprovider/{uuid}

(wafapplicationsignatureproviderUuidGet)

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

WafApplicationSignatureProvider

Example data

Content-Type: application/json

{
  "last_successful_check_for_updates" : "",
  "ruleset_version" : "aeiou",
  "available_applications" : [ {
    "application" : "aeiou",
    "last_changed_ruleset_version" : "aeiou",
    "number_of_rules" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "service_status" : {
    "error" : "aeiou",
    "last_successful_update_check" : "",
    "upstream_sync_timestamp" : ""
  },
  "last_failed_check_for_updates" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "uuid" : "aeiou",
  "last_check_for_updates_error" : "aeiou",
  "signatures" : [ {
    "mode" : "aeiou",
    "phase" : "aeiou",
    "rule_id" : "aeiou",
    "force_detection" : true,
    "enable" : true,
    "is_sensitive" : true,
    "name" : "aeiou",
    "index" : 123,
    "rule" : "aeiou",
    "exclude_list" : [ {
      "client_subnet" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "match_element" : "aeiou",
      "uri_path" : "aeiou",
      "uri_match_criteria" : "",
      "match_element_criteria" : {
        "match_op" : "aeiou",
        "match_case" : "aeiou"
      },
      "description" : "aeiou"
    } ],
    "tags" : [ "aeiou" ]
  } ],
  "url" : "aeiou",
  "_last_modified" : "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 WafApplicationSignatureProvider

401

patch /wafapplicationsignatureprovider/{uuid}

(wafapplicationsignatureproviderUuidPatch)

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 — WafApplicationSignatureProvider object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

WafApplicationSignatureProvider

Example data

Content-Type: application/json

{
  "last_successful_check_for_updates" : "",
  "ruleset_version" : "aeiou",
  "available_applications" : [ {
    "application" : "aeiou",
    "last_changed_ruleset_version" : "aeiou",
    "number_of_rules" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "service_status" : {
    "error" : "aeiou",
    "last_successful_update_check" : "",
    "upstream_sync_timestamp" : ""
  },
  "last_failed_check_for_updates" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "uuid" : "aeiou",
  "last_check_for_updates_error" : "aeiou",
  "signatures" : [ {
    "mode" : "aeiou",
    "phase" : "aeiou",
    "rule_id" : "aeiou",
    "force_detection" : true,
    "enable" : true,
    "is_sensitive" : true,
    "name" : "aeiou",
    "index" : 123,
    "rule" : "aeiou",
    "exclude_list" : [ {
      "client_subnet" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "match_element" : "aeiou",
      "uri_path" : "aeiou",
      "uri_match_criteria" : "",
      "match_element_criteria" : {
        "match_op" : "aeiou",
        "match_case" : "aeiou"
      },
      "description" : "aeiou"
    } ],
    "tags" : [ "aeiou" ]
  } ],
  "url" : "aeiou",
  "_last_modified" : "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 WafApplicationSignatureProvider

401

put /wafapplicationsignatureprovider/{uuid}

(wafapplicationsignatureproviderUuidPut)

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 — WafApplicationSignatureProvider object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

WafApplicationSignatureProvider

Example data

Content-Type: application/json

{
  "last_successful_check_for_updates" : "",
  "ruleset_version" : "aeiou",
  "available_applications" : [ {
    "application" : "aeiou",
    "last_changed_ruleset_version" : "aeiou",
    "number_of_rules" : 123
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "service_status" : {
    "error" : "aeiou",
    "last_successful_update_check" : "",
    "upstream_sync_timestamp" : ""
  },
  "last_failed_check_for_updates" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "uuid" : "aeiou",
  "last_check_for_updates_error" : "aeiou",
  "signatures" : [ {
    "mode" : "aeiou",
    "phase" : "aeiou",
    "rule_id" : "aeiou",
    "force_detection" : true,
    "enable" : true,
    "is_sensitive" : true,
    "name" : "aeiou",
    "index" : 123,
    "rule" : "aeiou",
    "exclude_list" : [ {
      "client_subnet" : {
        "ip_addr" : {
          "addr" : "aeiou",
          "type" : "aeiou"
        },
        "mask" : 123
      },
      "match_element" : "aeiou",
      "uri_path" : "aeiou",
      "uri_match_criteria" : "",
      "match_element_criteria" : {
        "match_op" : "aeiou",
        "match_case" : "aeiou"
      },
      "description" : "aeiou"
    } ],
    "tags" : [ "aeiou" ]
  } ],
  "url" : "aeiou",
  "_last_modified" : "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 WafApplicationSignatureProvider

401

Models

[ Jump to Methods ]

IpAddr
IpAddrPrefix
TimeStamp
WafApplicationSignatureAppVersion
WafApplicationSignatureProvider
WafApplicationSignatureProviderApiResponse
WafExcludeListEntry
WafExclusionType
WafRule
WebApplicationSignatureServiceStatus

IpAddr Up

addr

String IP address.

type

String Enum options - V4, DNS, V6.

IpAddrPrefix Up

ip_addr

IpAddr Placeholder for description of property ip_addr of obj type IpAddrPrefix field type str type object

mask

Integer Number of mask. format: int32

TimeStamp Up

secs

Long Number of secs. format: int64

usecs

Long Number of usecs. format: int64

WafApplicationSignatureAppVersion Up

application (optional)

String Name of an application in the rule set. Field introduced in 20.1.1.

last_changed_ruleset_version (optional)

String The last version of the rule set when the rules corresponding to the application changed. Field introduced in 20.1.1.

number_of_rules (optional)

Integer The number of rules available for this application. Field introduced in 20.1.3. format: int32

WafApplicationSignatureProvider Up

_last_modified (optional)

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

available_applications (optional)

array[WafApplicationSignatureAppVersion] Available application names and the ruleset version, when the rules for an application changed the last time. Field introduced in 20.1.1.

last_check_for_updates_error (optional)

String The error message indicating why the last update check failed. Field deprecated in 20.1.3. Field introduced in 20.1.1.

last_failed_check_for_updates (optional)

TimeStamp The last time that we checked for updates but did not get a result because of an error. Field deprecated in 20.1.3. Field introduced in 20.1.1.

last_successful_check_for_updates (optional)

TimeStamp The last time that we checked for updates sucessfully. Field deprecated in 20.1.3. Field introduced in 20.1.1.

name (optional)

String Name of Application Specific Ruleset Provider. Field introduced in 20.1.1.

ruleset_version (optional)

String Version of signatures. Field introduced in 20.1.1.

service_status (optional)

WebApplicationSignatureServiceStatus If this object is managed by the Application Signatures update service, this field contain the status of this syncronization. Field introduced in 20.1.3.

signatures (optional)

array[WafRule] The WAF rules. Not visible in the API. Field introduced in 20.1.1.

tenant_ref (optional)

String It is a reference to an object of type Tenant. Field introduced in 20.1.1.

url (optional)

String url

uuid (optional)

String Field introduced in 20.1.1.

WafApplicationSignatureProviderApiResponse Up

count

Integer format: int32

results

array[WafApplicationSignatureProvider]

next (optional)

String

WafExcludeListEntry Up

client_subnet (optional)

IpAddrPrefix Client IP Subnet to exclude for WAF rules. Field introduced in 17.2.1.

description (optional)

String Free-text comment about this exclusion. Field introduced in 18.2.6.

match_element (optional)

String The match_element can be 'ARGS xxx', 'ARGS_GET xxx', 'ARGS_POST xxx', 'ARGS_NAMES xxx', 'FILES xxx', 'QUERY_STRING', 'REQUEST_BASENAME', 'REQUEST_BODY', 'REQUEST_URI', 'REQUEST_URI_RAW', 'REQUEST_COOKIES xxx', 'REQUEST_HEADERS xxx', 'RESPONSE_HEADERS xxx' or XML xxx. These match_elements in the HTTP Transaction (if present) will be excluded when executing WAF Rules. Field introduced in 17.2.1.

match_element_criteria (optional)

WafExclusionType Criteria for match_element matching. Field introduced in 18.2.2.

uri_match_criteria (optional)

WafExclusionType Criteria for URI matching. Field introduced in 17.2.8.

uri_path (optional)

String URI Path to exclude for WAF rules. Field introduced in 17.2.1.

WafExclusionType Up

match_case

String Case sensitivity to use for the matching. Enum options - SENSITIVE, INSENSITIVE. Field introduced in 17.2.8.

match_op

String String Operation to use for matching the Exclusion. 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. Field introduced in 17.2.8.

WafRule Up

enable

Boolean Enable or disable WAF Rule Group. Field introduced in 17.2.1.

exclude_list (optional)

array[WafExcludeListEntry] Exclude list for the WAF rule. The fields in the exclude list entry are logically and'ed to deduce the exclusion criteria. If there are multiple excludelist entries, it will be 'logical or' of them. Field introduced in 17.2.3. Maximum of 64 items allowed.

force_detection (optional)

Boolean When set to 'true', this rule will not cause 'deny' or 'redirect' actions to run, even if WAF Policy is set to enforcement mode. The behavior would be as if this rule operated in detection mode regardless of WAF Policy setting. Field deprecated in 18.1.5. Field introduced in 18.1.4.

index

Integer Field introduced in 17.2.1. format: int32

is_sensitive (optional)

Boolean The rule field is sensitive and will not be displayed. Field introduced in 20.1.1.

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.1.5, 18.2.1.

name (optional)

String User-friendly optional name for a rule. Field introduced in 17.2.1.

phase (optional)

String The execution phase where this rule will be executed. Enum options - WAF_PHASE_CONNECTION, WAF_PHASE_REQUEST_HEADER, WAF_PHASE_REQUEST_BODY, WAF_PHASE_RESPONSE_HEADER, WAF_PHASE_RESPONSE_BODY, WAF_PHASE_LOGGING. Field introduced in 20.1.1.

rule

String Rule as per Modsec language. Field introduced in 17.2.1.

rule_id (optional)

String Identifier (id) for a rule per Modsec language. All SecRule and SecAction directives require an id. It is extracted from the id action in a Modsec rule. Rules within a single WAF Policy are required to have unique rule_ids. Field introduced in 17.2.2.

tags (optional)

array[String] Tags for WAF rule as per Modsec language. They are extracted from the tag actions in a Modsec rule. This field is generated from the rule itself and cannot be set by the user. Field introduced in 18.1.3. Maximum of 64 items allowed.

WebApplicationSignatureServiceStatus Up

error (optional)

String If the last attempted update failed, this is a more detailed error message. Field introduced in 20.1.3.

last_successful_update_check (optional)

TimeStamp The time when the Application Signature service last successfull attemped to update this object. It will be not update, if an error occurs during an update attempt. In this case, the error will be set. Field introduced in 20.1.3.

upstream_sync_timestamp (optional)

TimeStamp A timestamp field. It is used by the Application Signature Sync service to keep track of the current version. Field introduced in 20.1.5.

Avi WafApplicationSignatureProvider 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