Avi VSDataScriptSet Object API
CLI ``` - configure vsdatascriptset - show vsdatascriptset ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /vsdatascriptsetpost /vsdatascriptsetdelete /vsdatascriptset/{uuid}get /vsdatascriptset/{uuid}patch /vsdatascriptset/{uuid}put /vsdatascriptset/{uuid}
(vsdatascriptsetGet)
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"pool_refs" : [ "aeiou" ],
"string_group_refs" : [ "aeiou" ],
"pki_profile_refs" : [ "aeiou" ],
"description" : "aeiou",
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"ssl_profile_refs" : [ "aeiou" ],
"geo_db_ref" : "aeiou",
"protocol_parser_refs" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"rate_limiters" : [ {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
} ],
"pool_group_refs" : [ "aeiou" ],
"ssl_key_certificate_refs" : [ "aeiou" ],
"ipgroup_refs" : [ "aeiou" ],
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"datascript" : [ {
"evt" : "aeiou",
"script" : "aeiou"
} ],
"ip_reputation_db_ref" : "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.
Responses
200
OK
VSDataScriptSetApiResponse
401
log in failed
(vsdatascriptsetPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — VSDataScriptSet object creation
Return type
Example data
Content-Type: application/json
{
"pool_refs" : [ "aeiou" ],
"string_group_refs" : [ "aeiou" ],
"pki_profile_refs" : [ "aeiou" ],
"description" : "aeiou",
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"ssl_profile_refs" : [ "aeiou" ],
"geo_db_ref" : "aeiou",
"protocol_parser_refs" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"rate_limiters" : [ {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
} ],
"pool_group_refs" : [ "aeiou" ],
"ssl_key_certificate_refs" : [ "aeiou" ],
"ipgroup_refs" : [ "aeiou" ],
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"datascript" : [ {
"evt" : "aeiou",
"script" : "aeiou"
} ],
"ip_reputation_db_ref" : "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.
Responses
200
OK
VSDataScriptSet
401
log in failed
Up
delete /vsdatascriptset/{uuid}
(vsdatascriptsetUuidDelete)
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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /vsdatascriptset/{uuid}
(vsdatascriptsetUuidGet)
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
Example data
Content-Type: application/json
{
"pool_refs" : [ "aeiou" ],
"string_group_refs" : [ "aeiou" ],
"pki_profile_refs" : [ "aeiou" ],
"description" : "aeiou",
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"ssl_profile_refs" : [ "aeiou" ],
"geo_db_ref" : "aeiou",
"protocol_parser_refs" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"rate_limiters" : [ {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
} ],
"pool_group_refs" : [ "aeiou" ],
"ssl_key_certificate_refs" : [ "aeiou" ],
"ipgroup_refs" : [ "aeiou" ],
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"datascript" : [ {
"evt" : "aeiou",
"script" : "aeiou"
} ],
"ip_reputation_db_ref" : "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.
Responses
200
OK
VSDataScriptSet
401
log in failed
Up
patch /vsdatascriptset/{uuid}
(vsdatascriptsetUuidPatch)
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 — VSDataScriptSet object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"pool_refs" : [ "aeiou" ],
"string_group_refs" : [ "aeiou" ],
"pki_profile_refs" : [ "aeiou" ],
"description" : "aeiou",
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"ssl_profile_refs" : [ "aeiou" ],
"geo_db_ref" : "aeiou",
"protocol_parser_refs" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"rate_limiters" : [ {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
} ],
"pool_group_refs" : [ "aeiou" ],
"ssl_key_certificate_refs" : [ "aeiou" ],
"ipgroup_refs" : [ "aeiou" ],
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"datascript" : [ {
"evt" : "aeiou",
"script" : "aeiou"
} ],
"ip_reputation_db_ref" : "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.
Responses
200
OK
VSDataScriptSet
401
log in failed
Up
put /vsdatascriptset/{uuid}
(vsdatascriptsetUuidPut)
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 — VSDataScriptSet object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"pool_refs" : [ "aeiou" ],
"string_group_refs" : [ "aeiou" ],
"pki_profile_refs" : [ "aeiou" ],
"description" : "aeiou",
"created_by" : "aeiou",
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"ssl_profile_refs" : [ "aeiou" ],
"geo_db_ref" : "aeiou",
"protocol_parser_refs" : [ "aeiou" ],
"tenant_ref" : "aeiou",
"name" : "aeiou",
"configpb_attributes" : {
"version" : 123
},
"rate_limiters" : [ {
"period" : 123,
"count" : 123,
"name" : "aeiou",
"burst_sz" : 123
} ],
"pool_group_refs" : [ "aeiou" ],
"ssl_key_certificate_refs" : [ "aeiou" ],
"ipgroup_refs" : [ "aeiou" ],
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"datascript" : [ {
"evt" : "aeiou",
"script" : "aeiou"
} ],
"ip_reputation_db_ref" : "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.
Responses
200
OK
VSDataScriptSet
401
log in failed
[ Jump to Methods ]
Table of Contents
ConfigPbAttributesKeyValueRateLimiterRoleFilterMatchLabelVSDataScriptVSDataScriptSetVSDataScriptSetApiResponse
version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32
key
String Key. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
value (optional)
String Value. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
burst_sz (optional)
Integer Maximum number of connections, requests or packets to be let through instantaneously. If this is less than count, it will have no effect. Allowed values are 0-1000000000. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 0), Essentials, Enterprise with Cloud Services edition. format: int32
count
Integer Maximum number of connections, requests or packets permitted each period. Allowed values are 1-1000000000. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
name (optional)
String Identifier for Rate Limit. Constructed according to context. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
period
Integer Time value in seconds to enforce rate count. Allowed values are 1-1000000000. Field introduced in 18.2.9. Unit is SEC. Allowed in Enterprise edition with any value, Basic edition(Allowed values- 1), Essentials, Enterprise with Cloud Services edition. format: int32
key
String Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
evt
String Event triggering execution of datascript. Enum options - VS_DATASCRIPT_EVT_HTTP_REQ, VS_DATASCRIPT_EVT_HTTP_RESP, VS_DATASCRIPT_EVT_HTTP_RESP_DATA, VS_DATASCRIPT_EVT_HTTP_LB_FAILED, VS_DATASCRIPT_EVT_HTTP_REQ_DATA, VS_DATASCRIPT_EVT_HTTP_RESP_FAILED, VS_DATASCRIPT_EVT_HTTP_LB_DONE, VS_DATASCRIPT_EVT_HTTP_AUTH, VS_DATASCRIPT_EVT_HTTP_POST_AUTH, VS_DATASCRIPT_EVT_TCP_CLIENT_ACCEPT, VS_DATASCRIPT_EVT_SSL_HANDSHAKE_DONE, VS_DATASCRIPT_EVT_CLIENT_SSL_PRE_CONNECT, VS_DATASCRIPT_EVT_CLIENT_SSL_CLIENT_HELLO, VS_DATASCRIPT_EVT_DNS_REQ, VS_DATASCRIPT_EVT_DNS_RESP, VS_DATASCRIPT_EVT_L4_REQUEST, VS_DATASCRIPT_EVT_L4_RESPONSE, VS_DATASCRIPT_EVT_MAX. Allowed in Enterprise edition with any value, Basic edition(Allowed values- VS_DATASCRIPT_EVT_HTTP_REQ,VS_DATASCRIPT_EVT_HTTP_RESP), Essentials, Enterprise with Cloud Services edition.
script
String Datascript to execute when the event triggers. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
created_by (optional)
String Creator name. Field introduced in 17.1.11,17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
datascript (optional)
array[VSDataScript] DataScripts to execute. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
description (optional)
String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
geo_db_ref (optional)
String Geo Location Mapping Database used by this DataScriptSet. It is a reference to an object of type GeoDB. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip_reputation_db_ref (optional)
String IP reputation database that can be used by DataScript functions. It is a reference to an object of type IPReputationDB. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ipgroup_refs (optional)
array[String] UUID of IP Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type IpAddrGroup. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
name
String Name for the virtual service datascript collection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pki_profile_refs (optional)
array[String] UUIDs of PKIProfile objects that could be referred by VSDataScriptSet objects. It is a reference to an object of type PKIProfile. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pool_group_refs (optional)
array[String] UUID of pool groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type PoolGroup. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
pool_refs (optional)
array[String] UUID of pools that could be referred by VSDataScriptSet objects. It is a reference to an object of type Pool. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
protocol_parser_refs (optional)
array[String] List of protocol parsers that could be referred by VSDataScriptSet objects. It is a reference to an object of type ProtocolParser. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
rate_limiters (optional)
array[RateLimiter] The Rate Limit definitions needed for this DataScript. The name is composed of the Virtual Service name and the DataScript name. Field introduced in 18.2.9. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_key_certificate_refs (optional)
array[String] UUIDs of SSLKeyAndCertificate objects that could be referred by VSDataScriptSet objects. It is a reference to an object of type SSLKeyAndCertificate. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_profile_refs (optional)
array[String] UUIDs of SSLProfile objects that could be referred by VSDataScriptSet objects. It is a reference to an object of type SSLProfile. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
string_group_refs (optional)
array[String] UUID of String Groups that could be referred by VSDataScriptSet objects. It is a reference to an object of type StringGroup. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the virtual service datascript collection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
count
results
next (optional)