POST /vsdatascriptset

POST /vsdatascriptset

/vsdatascriptset

Request
URI
POST
https://api_host/api/vsdatascriptset
COPY
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.

Request Body
VSDataScriptSet of type(s) application/json
Optional 
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "created_by": "string",
    "datascript": [
        {
            "evt": "string",
            "script": "string"
        }
    ],
    "description": "string",
    "geo_db_ref": "string",
    "ip_reputation_db_ref": "string",
    "ipgroup_refs": [
        "string"
    ],
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "pki_profile_refs": [
        "string"
    ],
    "pool_group_refs": [
        "string"
    ],
    "pool_refs": [
        "string"
    ],
    "protocol_parser_refs": [
        "string"
    ],
    "rate_limiters": [
        {
            "burst_sz": 0,
            "count": 0,
            "name": "string",
            "period": 0
        }
    ],
    "ssl_key_certificate_refs": [
        "string"
    ],
    "ssl_profile_refs": [
        "string"
    ],
    "string_group_refs": [
        "string"
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
created_by
Optional

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.

array of VSDataScript
datascript
Optional

DataScripts to execute. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

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

string
geo_db_ref
Optional

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.

string
ip_reputation_db_ref
Optional

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.

array of string
ipgroup_refs
Optional

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.

array of RoleFilterMatchLabel
markers
Optional

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.

string
name
Required

Name for the virtual service datascript collection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
pki_profile_refs
Optional

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.

array of string
pool_group_refs
Optional

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.

array of string
pool_refs
Optional

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.

array of string
protocol_parser_refs
Optional

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.

array of RateLimiter
rate_limiters
Optional

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.

array of string
ssl_key_certificate_refs
Optional

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.

array of string
ssl_profile_refs
Optional

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.

array of string
string_group_refs
Optional

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.

string
tenant_ref
Optional

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

string
url
Optional

url

string
uuid
Optional

UUID of the virtual service datascript collection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Responses
200

OK

Returns VSDataScriptSet of type(s) application/json 
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "created_by": "string",
    "datascript": [
        {
            "evt": "string",
            "script": "string"
        }
    ],
    "description": "string",
    "geo_db_ref": "string",
    "ip_reputation_db_ref": "string",
    "ipgroup_refs": [
        "string"
    ],
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "pki_profile_refs": [
        "string"
    ],
    "pool_group_refs": [
        "string"
    ],
    "pool_refs": [
        "string"
    ],
    "protocol_parser_refs": [
        "string"
    ],
    "rate_limiters": [
        {
            "burst_sz": 0,
            "count": 0,
            "name": "string",
            "period": 0
        }
    ],
    "ssl_key_certificate_refs": [
        "string"
    ],
    "ssl_profile_refs": [
        "string"
    ],
    "string_group_refs": [
        "string"
    ],
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

ConfigPbAttributes
configpb_attributes
Optional

configpb_attributes

string
created_by
Optional

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.

array of VSDataScript
datascript
Optional

DataScripts to execute. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Optional

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

string
geo_db_ref
Optional

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.

string
ip_reputation_db_ref
Optional

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.

array of string
ipgroup_refs
Optional

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.

array of RoleFilterMatchLabel
markers
Optional

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.

string
name
Required

Name for the virtual service datascript collection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

array of string
pki_profile_refs
Optional

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.

array of string
pool_group_refs
Optional

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.

array of string
pool_refs
Optional

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.

array of string
protocol_parser_refs
Optional

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.

array of RateLimiter
rate_limiters
Optional

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.

array of string
ssl_key_certificate_refs
Optional

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.

array of string
ssl_profile_refs
Optional

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.

array of string
string_group_refs
Optional

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.

string
tenant_ref
Optional

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

string
url
Optional

url

string
uuid
Optional

UUID of the virtual service datascript collection. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

On This Page
Vsdata Script Set Operations
DELETE
DELETE /vsdatascriptset/{uuid}
GET
GET /vsdatascriptset
GET
GET /vsdatascriptset/{uuid}
PATCH
PATCH /vsdatascriptset/{uuid}
POST
POST /vsdatascriptset
PUT
PUT /vsdatascriptset/{uuid}