Avi SecurityManagerData Object API

CLI ``` - show secmgrdata ```

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 /securitymanagerdata
post /securitymanagerdata
delete /securitymanagerdata/{uuid}
get /securitymanagerdata/{uuid}
patch /securitymanagerdata/{uuid}
put /securitymanagerdata/{uuid}

get /securitymanagerdata

(securitymanagerdataGet)

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

SecurityManagerDataApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "app_learning_info" : [ {
      "vs_uuid" : "aeiou",
      "uri_info" : [ {
        "uri_key" : "aeiou",
        "uri_hits" : 123456789,
        "param_info" : [ {
          "param_key" : "aeiou",
          "param_size_classes" : [ {
            "hits" : 123456789,
            "len" : "aeiou"
          } ],
          "param_type_classes" : [ {
            "hits" : 123456789,
            "type" : "aeiou"
          } ],
          "param_hits" : 123456789
        } ]
      } ],
      "app_id" : "aeiou"
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "uuid" : "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 SecurityManagerDataApiResponse

401

post /securitymanagerdata

(securitymanagerdataPost)

Consumes

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

application/json

Request body

body (required)

Body Parameter — SecurityManagerData object creation

Return type

SecurityManagerData

Example data

Content-Type: application/json

{
  "app_learning_info" : [ {
    "vs_uuid" : "aeiou",
    "uri_info" : [ {
      "uri_key" : "aeiou",
      "uri_hits" : 123456789,
      "param_info" : [ {
        "param_key" : "aeiou",
        "param_size_classes" : [ {
          "hits" : 123456789,
          "len" : "aeiou"
        } ],
        "param_type_classes" : [ {
          "hits" : 123456789,
          "type" : "aeiou"
        } ],
        "param_hits" : 123456789
      } ]
    } ],
    "app_id" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "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 SecurityManagerData

401

delete /securitymanagerdata/{uuid}

(securitymanagerdataUuidDelete)

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

(securitymanagerdataUuidGet)

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

SecurityManagerData

Example data

Content-Type: application/json

{
  "app_learning_info" : [ {
    "vs_uuid" : "aeiou",
    "uri_info" : [ {
      "uri_key" : "aeiou",
      "uri_hits" : 123456789,
      "param_info" : [ {
        "param_key" : "aeiou",
        "param_size_classes" : [ {
          "hits" : 123456789,
          "len" : "aeiou"
        } ],
        "param_type_classes" : [ {
          "hits" : 123456789,
          "type" : "aeiou"
        } ],
        "param_hits" : 123456789
      } ]
    } ],
    "app_id" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "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 SecurityManagerData

401

patch /securitymanagerdata/{uuid}

(securitymanagerdataUuidPatch)

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

Query parameters

name (optional)

Query Parameter — object name

Return type

SecurityManagerData

Example data

Content-Type: application/json

{
  "app_learning_info" : [ {
    "vs_uuid" : "aeiou",
    "uri_info" : [ {
      "uri_key" : "aeiou",
      "uri_hits" : 123456789,
      "param_info" : [ {
        "param_key" : "aeiou",
        "param_size_classes" : [ {
          "hits" : 123456789,
          "len" : "aeiou"
        } ],
        "param_type_classes" : [ {
          "hits" : 123456789,
          "type" : "aeiou"
        } ],
        "param_hits" : 123456789
      } ]
    } ],
    "app_id" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "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 SecurityManagerData

401

put /securitymanagerdata/{uuid}

(securitymanagerdataUuidPut)

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

Query parameters

name (optional)

Query Parameter — object name

Return type

SecurityManagerData

Example data

Content-Type: application/json

{
  "app_learning_info" : [ {
    "vs_uuid" : "aeiou",
    "uri_info" : [ {
      "uri_key" : "aeiou",
      "uri_hits" : 123456789,
      "param_info" : [ {
        "param_key" : "aeiou",
        "param_size_classes" : [ {
          "hits" : 123456789,
          "len" : "aeiou"
        } ],
        "param_type_classes" : [ {
          "hits" : 123456789,
          "type" : "aeiou"
        } ],
        "param_hits" : 123456789
      } ]
    } ],
    "app_id" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "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 SecurityManagerData

401

Models

[ Jump to Methods ]

DbAppLearningInfo
ParamInfo
ParamSizeClass
ParamTypeClass
SecurityManagerData
SecurityManagerDataApiResponse
URIInfo

DbAppLearningInfo Up

app_id (optional)

String Application UUID. Combination of Virtualservice UUID and WAF Policy UUID. Field introduced in 20.1.1.

uri_info (optional)

array[URIInfo] Information about various URIs under a application. Field introduced in 20.1.1.

vs_uuid (optional)

String Virtualserivce UUID. Field introduced in 20.1.1.

ParamInfo Up

param_hits (optional)

Long Number of hits for a param. Field introduced in 20.1.1. format: int64

param_key (optional)

String Param name. Field introduced in 20.1.1.

param_size_classes (optional)

array[ParamSizeClass] Various param size and its respective hit count. Field introduced in 20.1.1.

param_type_classes (optional)

array[ParamTypeClass] Various param type and its respective hit count. Field introduced in 20.1.1.

ParamSizeClass Up

hits (optional)

Long Field introduced in 20.1.1. format: int64

len (optional)

String Enum options - EMPTY, SMALL, MEDIUM, LARGE, UNLIMITED. Field introduced in 20.1.1.

ParamTypeClass Up

hits (optional)

Long Field introduced in 20.1.1. format: int64

type (optional)

String Enum options - PARAM_FLAG, PARAM_DIGITS, PARAM_HEXDIGITS, PARAM_WORD, PARAM_SAFE_TEXT, PARAM_SAFE_TEXT_MULTILINE, PARAM_TEXT, PARAM_TEXT_MULTILINE, PARAM_ALL. Field introduced in 20.1.1.

SecurityManagerData Up

_last_modified (optional)

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

app_learning_info (optional)

array[DbAppLearningInfo] Information about various applications. Field introduced in 20.1.1.

name

String Virtualservice Name. 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 Virtualservice UUID. Field introduced in 20.1.1.

SecurityManagerDataApiResponse Up

count

Integer format: int32

results

array[SecurityManagerData]

next (optional)

String

URIInfo Up

param_info (optional)

array[ParamInfo] Information about various params under a URI. Field introduced in 20.1.1.

uri_hits (optional)

Long Total number of URI hits. Field introduced in 20.1.1. format: int64

uri_key (optional)

String URI name. Field introduced in 20.1.1.

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