GET /positivesecuritypolicy/{uuid}

GET /positivesecuritypolicy/{uuid}

/positivesecuritypolicy/{uuid}/{uuid}

Request
URI
GET
https://{api_host}/api/positivesecuritypolicy/{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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PositiveSecurityPolicy of type(s) application/json 
{
    "_last_modified": "string",
    "description": "string",
    "enable_positive_security_rule_updates": false,
    "enable_regex_programming": false,
    "name": "string",
    "positive_security_params": {
        "confidence_override": {
            "confid_high_value": 0,
            "confid_low_value": 0,
            "confid_probable_value": 0,
            "confid_very_high_value": 0
        },
        "max_params": 0,
        "max_uris": 0,
        "min_confidence": "string",
        "min_hits_to_program": 0
    },
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

string
description
Optional

Details of the Positive Security Configuration. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean
enable_positive_security_rule_updates
Optional

Enable Positive Security rule generation using the application learning data Rules will be programmed in a dedicated learning group. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean
enable_regex_programming
Optional

Enable dynamic regex generation for positive security rules. This is an experimental feature and shouldn't be used in production. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Optional

The name of the PositiveSecurity Configuration. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
positive_security_params
Optional

positive_security_params

string
tenant_ref
Optional

Details of the tenant for positive security policy. It is a reference to an object of type Tenant. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the Positive Security Configuration. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

404

object not found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/positivesecuritypolicy/{uuid}
On This Page
Positive Security Policy Operations
GET
GET /positivesecuritypolicy
POST
POST /positivesecuritypolicy
GET
GET /positivesecuritypolicy/{uuid}
PUT
PUT /positivesecuritypolicy/{uuid}
PATCH
PATCH /positivesecuritypolicy/{uuid}
DELETE
DELETE /positivesecuritypolicy/{uuid}