GET /wafapplicationsignatureprovider/{uuid}

/wafapplicationsignatureprovider/{uuid}

Request

URI

GET

https://api_host/api/wafapplicationsignatureprovider/{uuid}

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Query Parameters

string

name

Optional

object name

string

fields

Optional

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

boolean

include_name

Optional

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.

boolean

skip_default

Optional

Default values are not set.

string

join_subresources

Optional

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

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

string

X-Avi-Version

Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string

X-CSRFToken

Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Responses

200

Returns WafApplicationSignatureProvider of type(s) application/json

{
    "_last_modified": "string",
    "available_applications": [
        {
            "application": "string",
            "last_changed_ruleset_version": "string",
            "number_of_rules": 0
        }
    ],
    "configpb_attributes": {
        "version": 0
    },
    "filter_rules_on_import": false,
    "name": "string",
    "ruleset_version": "string",
    "service_status": {
        "error": "string",
        "last_successful_update_check": {
            "secs": 0,
            "usecs": 0
        },
        "upstream_sync_timestamp": {
            "secs": 0,
            "usecs": 0
        }
    },
    "signatures": [
        {
            "enable": false,
            "exclude_list": [
                {
                    "client_subnet": {
                        "ip_addr": {
                            "addr": "string",
                            "type": "string"
                        },
                        "mask": 0
                    },
                    "description": "string",
                    "match_element": "string",
                    "match_element_criteria": {
                        "match_case": "string",
                        "match_op": "string"
                    },
                    "uri_match_criteria": {
                        "match_case": "string",
                        "match_op": "string"
                    },
                    "uri_path": "string"
                }
            ],
            "index": 0,
            "is_sensitive": false,
            "mode": "string",
            "name": "string",
            "paranoia_level": "string",
            "phase": "string",
            "rule": "string",
            "rule_id": "string",
            "tags": [
                "string"
            ]
        }
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}

string

_last_modified

Optional

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

array of WafApplicationSignatureAppVersion

available_applications

Optional

Available application names and the ruleset version, when the rules for an application changed the last time. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes

configpb_attributes

Optional

configpb_attributes

boolean

filter_rules_on_import

Optional

If this is set to false, all provided rules are imported when updating this object. If this is set to true, only newer rules are considered for import. Newer rules are rules where the rule id is not in the range of 2,000,000 to 2,080,000 or where the rule has a tag with a CVE from 2013 or newer. All other rules are ignored on rule import. Field introduced in 30.2.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string

name

Optional

Name of Application Specific Ruleset Provider. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string

ruleset_version

Optional

Version of signatures. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

WebApplicationSignatureServiceStatus

service_status

Optional

service_status

array of WafRule

signatures

Optional

The WAF rules. Not visible in the API. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string

tenant_ref

Optional

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

string

url

Optional

url

string

uuid

Optional

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

401

Operation doesn't return any data structure

On This Page

Description