GET /virtualservice
/virtualservice
Request
URI
GET
https://{api_host}/api/virtualservice
COPY
Query Parameters
string
name
Optional
object name
string
refers_to
Optional
Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=
string
referred_by
Optional
Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=
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.
string
cloud_uuid
Optional
Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
string
cloud_ref.name
Optional
Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.
string
cloud_ref.uuid
Optional
Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_ref.uuid=cloud_uuid.
string
name.contains
Optional
Filter to get objects with name that contains the parameter. This is a case sensitive search. Eg. name.contains=pool-.
string
name.icontains
Optional
Filter to get objects with name that contains the parameter. This is a case insensitive search. Eg. name.icontains=pool-.
string
name.in
Optional
Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. name.in=pool-1,pool-12.
string
uuid.in
Optional
Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. uuid.in=
string
search
Optional
Filter to get objects that contains the search string as value for any of its fields. Eg. search=LEAST_CONN. The search filter can also be used to search under a specific field. This is achieved by sending the parameter as ?search=(
string
isearch
Optional
Filter to get objects that contains case insensitive search string. Eg. isearch=(name,Vs-Pool-).
string
limit_by
Optional
Filter to limit the number of objects in the response data. Eg. limit_by=3.
string
exclude
Optional
Filter to exclude the uuid(s) contained in the parameter. Eg. uuid.in=
string
sort
Optional
Parameter to sort the results with respect to a field. Eg. sort=name.
string
page_size
Optional
Parameter to specify the maximum number of results to be returned per page. The page_size can range from 1 to 200. Eg. page_size=5.
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
OK
Returns
VirtualServiceApiResponse
of type(s)
application/json
{
"count": 0,
"results": [
{
"_last_modified": "string",
"active_standby_se_tag": "string",
"advertise_down_vs": false,
"allow_invalid_client_cert": false,
"analytics_policy": {
"all_headers": false,
"client_insights": "string",
"client_insights_sampling": {
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"sample_uris": {
"match_criteria": "string",
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"skip_uris": {
"match_criteria": "string",
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
}
},
"client_log_filters": [
{
"all_headers": false,
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"duration": 0,
"enabled": false,
"index": 0,
"name": "string",
"uri": {
"match_criteria": "string",
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
}
}
],
"full_client_logs": {
"duration": 0,
"enabled": false,
"throttle": 0
},
"learning_log_policy": {
"enabled": false,
"host": "string",
"port": 0
},
"metrics_realtime_update": {
"duration": 0,
"enabled": false
},
"significant_log_throttle": 0,
"udf_log_throttle": 0
},
"analytics_profile_ref": "string",
"application_profile_ref": "string",
"azure_availability_set": "string",
"bgp_local_preference": 0,
"bgp_num_as_path_prepend": 0,
"bgp_peer_labels": [
"string"
],
"bot_policy_ref": "string",
"bulk_sync_kvcache": false,
"close_client_conn_on_config_update": false,
"cloud_config_cksum": "string",
"cloud_ref": "string",
"cloud_type": "string",
"configpb_attributes": {
"version": 0
},
"connections_rate_limit": {
"action": {
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"redirect": {
"add_string": "string",
"host": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"keep_query": false,
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"port": 0,
"protocol": "string",
"status_code": "string"
},
"status_code": "string",
"type": "string"
},
"explicit_tracking": false,
"fine_grain": false,
"http_cookie": "string",
"http_header": "string",
"rate_limiter": {
"burst_sz": 0,
"count": 0,
"name": "string",
"period": 0
}
},
"content_rewrite": {
"rewritable_content_ref": "string",
"rsp_rewrite_rules": [
{
"enable": false,
"index": 0,
"name": "string",
"pairs": [
{
"replacement_string": {
"type": "string",
"val": "string"
},
"search_string": {
"type": "string",
"val": "string"
}
}
]
}
]
},
"created_by": "string",
"csrf_policy_ref": "string",
"delay_fairness": false,
"description": "string",
"dns_info": [
{
"algorithm": "string",
"cname": {
"cname": "string"
},
"fqdn": "string",
"metadata": "string",
"num_records_in_response": 0,
"ttl": 0,
"type": "string"
}
],
"dns_policies": [
{
"dns_policy_ref": "string",
"index": 0
}
],
"east_west_placement": false,
"enable_autogw": false,
"enable_rhi": false,
"enable_rhi_snat": false,
"enable_session": false,
"enabled": false,
"error_page_profile_ref": "string",
"flow_dist": "string",
"flow_label_type": "string",
"fqdn": "string",
"host_name_xlate": "string",
"http_policies": [
{
"http_policy_set_ref": "string",
"index": 0
}
],
"icap_request_profile_refs": [
"string"
],
"ign_pool_net_reach": false,
"jwt_config": {
"audience": "string",
"jwt_location": "string",
"jwt_name": "string"
},
"l4_policies": [
{
"index": 0,
"l4_policy_set_ref": "string"
}
],
"ldap_vs_config": {
"realm": "string",
"se_auth_ldap_bind_timeout": 0,
"se_auth_ldap_cache_size": 0,
"se_auth_ldap_connect_timeout": 0,
"se_auth_ldap_conns_per_server": 0,
"se_auth_ldap_reconnect_timeout": 0,
"se_auth_ldap_request_timeout": 0,
"se_auth_ldap_servers_failover_only": false
},
"limit_doser": false,
"markers": [
{
"key": "string",
"values": [
"string"
]
}
],
"max_cps_per_client": 0,
"microservice_ref": "string",
"min_pools_up": 0,
"name": "string",
"network_profile_ref": "string",
"network_security_policy_ref": "string",
"nsx_securitygroup": [
"string"
],
"oauth_vs_config": {
"cookie_name": "string",
"cookie_timeout": 0,
"key": [
{
"aes_key": "string",
"hmac_key": "string",
"name": "string"
}
],
"logout_uri": "string",
"oauth_settings": [
{
"app_settings": {
"client_id": "string",
"client_secret": "string",
"oidc_config": {
"oidc_enable": false,
"profile": false,
"userinfo": false
},
"scopes": [
"string"
]
},
"auth_profile_ref": "string",
"resource_server": {
"access_type": "string",
"introspection_data_timeout": 0,
"jwt_params": {
"audience": "string"
},
"opaque_token_params": {
"server_id": "string",
"server_secret": "string"
}
}
}
],
"post_logout_redirect_uri": "string",
"redirect_uri": "string"
},
"performance_limits": {
"max_concurrent_connections": 0,
"max_throughput": 0
},
"pool_group_ref": "string",
"pool_ref": "string",
"remove_listening_port_on_vs_down": false,
"requests_rate_limit": {
"action": {
"file": {
"content_type": "string",
"file_content": "string",
"file_length": 0
},
"redirect": {
"add_string": "string",
"host": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"keep_query": false,
"path": {
"tokens": [
{
"end_index": 0,
"start_index": 0,
"str_value": "string",
"type": "string"
}
],
"type": "string"
},
"port": 0,
"protocol": "string",
"status_code": "string"
},
"status_code": "string",
"type": "string"
},
"explicit_tracking": false,
"fine_grain": false,
"http_cookie": "string",
"http_header": "string",
"rate_limiter": {
"burst_sz": 0,
"count": 0,
"name": "string",
"period": 0
}
},
"revoke_vip_route": false,
"saml_sp_config": {
"acs_index": 0,
"authn_req_acs_type": "string",
"cookie_name": "string",
"cookie_timeout": 0,
"entity_id": "string",
"key": [
{
"aes_key": "string",
"hmac_key": "string",
"name": "string"
}
],
"signing_ssl_key_and_certificate_ref": "string",
"single_signon_url": "string",
"sp_metadata": "string",
"use_idp_session_timeout": false
},
"scaleout_ecmp": false,
"se_group_ref": "string",
"security_policy_ref": "string",
"server_network_profile_ref": "string",
"service_metadata": "string",
"service_pool_select": [
{
"service_pool_group_ref": "string",
"service_pool_ref": "string",
"service_port": 0,
"service_port_range_end": 0,
"service_protocol": "string"
}
],
"services": [
{
"enable_http2": false,
"enable_ssl": false,
"horizon_internal_ports": false,
"is_active_ftp_data_port": false,
"override_application_profile_ref": "string",
"override_network_profile_ref": "string",
"port": 0,
"port_range_end": 0
}
],
"sideband_profile": {
"ip": [
{
"addr": "string",
"type": "string"
}
],
"sideband_max_request_body_size": 0
},
"snat_ip": [
{
"addr": "string",
"type": "string"
}
],
"snat_ip6_addresses": [
{
"addr": "string",
"type": "string"
}
],
"sp_pool_refs": [
"string"
],
"ssl_key_and_certificate_refs": [
"string"
],
"ssl_profile_ref": "string",
"ssl_profile_selectors": [
{
"client_ip_list": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"ssl_profile_ref": "string"
}
],
"ssl_sess_cache_avg_size": 0,
"sso_policy_ref": "string",
"static_dns_records": [
{
"algorithm": "string",
"cname": {
"cname": "string"
},
"delegated": false,
"description": "string",
"fqdn": [
"string"
],
"ip6_address": [
{
"ip6_address": {
"addr": "string",
"type": "string"
}
}
],
"ip_address": [
{
"ip_address": {
"addr": "string",
"type": "string"
}
}
],
"metadata": "string",
"mx_records": [
{
"host": "string",
"priority": 0
}
],
"ns": [
{
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"nsname": "string"
}
],
"num_records_in_response": 0,
"service_locator": [
{
"port": 0,
"priority": 0,
"target": "string",
"weight": 0
}
],
"ttl": 0,
"txt_records": [
{
"text_str": "string"
}
],
"type": "string",
"wildcard_match": false
}
],
"tenant_ref": "string",
"test_se_datastore_level_1_ref": "string",
"topology_policies": [
{
"dns_policy_ref": "string",
"index": 0
}
],
"traffic_clone_profile_ref": "string",
"traffic_enabled": false,
"type": "string",
"url": "string",
"use_bridge_ip_as_vip": false,
"use_vip_as_snat": false,
"uuid": "string",
"vh_domain_name": [
"string"
],
"vh_matches": [
{
"host": "string",
"rules": [
{
"matches": {
"bot_detection_result": {
"classifications": [
{
"type": "string",
"user_defined_type": "string"
}
],
"match_operation": "string"
},
"client_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"cookie": {
"match_case": "string",
"match_criteria": "string",
"name": "string",
"value": "string"
},
"geo_matches": [
{
"attribute": "string",
"match_operation": "string",
"values": [
"string"
]
}
],
"hdrs": [
{
"hdr": "string",
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
}
],
"host_hdr": {
"match_case": "string",
"match_criteria": "string",
"value": [
"string"
]
},
"ip_reputation_type": {
"match_operation": "string",
"reputation_types": [
"string"
]
},
"method": {
"match_criteria": "string",
"methods": [
"string"
]
},
"path": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"protocol": {
"match_criteria": "string",
"protocols": "string"
},
"query": {
"match_case": "string",
"match_criteria": "string",
"match_decoded_string": false,
"match_str": [
"string"
],
"string_group_refs": [
"string"
]
},
"source_ip": {
"addrs": [
{
"addr": "string",
"type": "string"
}
],
"group_refs": [
"string"
],
"match_criteria": "string",
"prefixes": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"ranges": [
{
"begin": {
"addr": "string",
"type": "string"
},
"end": {
"addr": "string",
"type": "string"
}
}
]
},
"tls_fingerprint_match": {
"fingerprints": [
"string"
],
"match_operation": "string",
"string_group_refs": [
"string"
]
},
"version": {
"match_criteria": "string",
"versions": [
"string"
]
},
"vs_port": {
"match_criteria": "string",
"ports": [
0
]
}
},
"name": "string"
}
]
}
],
"vh_parent_vs_ref": "string",
"vh_type": "string",
"vip": [
{
"auto_allocate_floating_ip": false,
"auto_allocate_ip": false,
"auto_allocate_ip_type": "string",
"availability_zone": "string",
"avi_allocated_fip": false,
"avi_allocated_vip": false,
"discovered_networks": [
{
"network_ref": "string",
"subnet": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
],
"subnet6": [
{
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
]
}
],
"enabled": false,
"floating_ip": {
"addr": "string",
"type": "string"
},
"floating_ip6": {
"addr": "string",
"type": "string"
},
"floating_subnet6_uuid": "string",
"floating_subnet_uuid": "string",
"ip6_address": {
"addr": "string",
"type": "string"
},
"ip_address": {
"addr": "string",
"type": "string"
},
"ipam_network_subnet": {
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string"
},
"network_ref": "string",
"placement_networks": [
{
"network_ref": "string",
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
}
}
],
"port_uuid": "string",
"prefix_length": 0,
"subnet": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6": {
"ip_addr": {
"addr": "string",
"type": "string"
},
"mask": 0
},
"subnet6_uuid": "string",
"subnet_uuid": "string",
"vip_id": "string"
}
],
"vrf_context_ref": "string",
"vs_datascripts": [
{
"index": 0,
"vs_datascript_set_ref": "string"
}
],
"vsvip_cloud_config_cksum": "string",
"vsvip_ref": "string",
"waf_policy_ref": "string",
"weight": 0
}
],
"next": "string"
}
integer As int32
As int32
count
Required
count
array of
object
results
Required
results
string
next
Optional
next
401
log in failed
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/virtualservice
On This Page
Virtual Service Operations
GET
GET /virtualservice
POST
POST /virtualservice
GET
GET /virtualservice/{uuid}
PUT
PUT /virtualservice/{uuid}
PATCH
PATCH /virtualservice/{uuid}
DELETE
DELETE /virtualservice/{uuid}
POST
POST /virtualservice/{uuid}/scaleout
POST
POST /virtualservice/{uuid}/scalein
POST
POST /virtualservice/{uuid}/migrate
POST
POST /virtualservice/{uuid}/switchover
POST
POST /virtualservice/clear
POST
POST /virtualservice/{uuid}/resync
POST
POST /virtualservice/{uuid}/rotatekeys
POST
POST /virtualservice/{uuid}/retryplacement
POST
POST /virtualservice/{uuid}/log-recommendation
POST
POST /virtualservice/{uuid}/apply-log-recommendation
GET
GET /virtualservice/{uuid}/runtime
GET
GET /virtualservice/{uuid}/runtime/detail
GET
GET /virtualservice/{uuid}/runtime/internal
GET
GET /virtualservice/{uuid}/udpstat
GET
GET /virtualservice/{uuid}/tcpstat
GET
GET /virtualservice/{uuid}/sctpstat
GET
GET /virtualservice/{uuid}/traffic_clone_stats
GET
GET /virtualservice/{uuid}/dosstat
GET
GET /virtualservice/{uuid}/connections
GET
GET /virtualservice/{uuid}/httpconnections
GET
GET /virtualservice/{uuid}/httpconnections/detail
GET
GET /virtualservice/{uuid}/httpstats
GET
GET /virtualservice/{uuid}/authstats
GET
GET /virtualservice/{uuid}/httppolicyset
GET
GET /virtualservice/{uuid}/httppolicysetstats
GET
GET /virtualservice/{uuid}/dnspolicystats
GET
GET /virtualservice/{uuid}/networksecuritypolicystats
GET
GET /virtualservice/{uuid}/networksecuritypolicy/detail
GET
GET /virtualservice/{uuid}/candidatesehostlist
GET
GET /virtualservice/{uuid}/placement
GET
GET /virtualservice/{uuid}/keyval
GET
GET /virtualservice/{uuid}/keyvalsummary
GET
GET /virtualservice/{uuid}/keyvalsummaryobjsync
GET
GET /virtualservice/{uuid}/keyvaldispatch
GET
GET /virtualservice/{uuid}/keyvalsession
GET
GET /virtualservice/{uuid}/keyvalsessionsummary
GET
GET /virtualservice/{uuid}/sslsessioncache
GET
GET /virtualservice/{uuid}/vslogstats
GET
GET /virtualservice/{uuid}/aggrvslogstats
GET
GET /virtualservice/{uuid}/cltrack
GET
GET /virtualservice/{uuid}/cltracksummary
GET
GET /virtualservice/{uuid}/client
GET
GET /virtualservice/{uuid}/clientsummary
GET
GET /virtualservice/{uuid}/dnstable
GET
GET /virtualservice/{uuid}/gslbservicedetail
GET
GET /virtualservice/{uuid}/gslbserviceinternal
GET
GET /virtualservice/{uuid}/gslbservicealgostat
GET
GET /virtualservice/{uuid}/gslbservicehmonstat
GET
GET /virtualservice/{uuid}/geolocationinfo
GET
GET /virtualservice/{uuid}/geodbinternal
GET
GET /virtualservice/{uuid}/gslbsiteinternal
GET
GET /virtualservice/{uuid}/userdefineddatascriptcounters
GET
GET /virtualservice/{uuid}/l4policysetstats
GET
GET /virtualservice/{uuid}/sescaleoutstatus
GET
GET /virtualservice/{uuid}/scaleoutstatus
GET
GET /virtualservice/{uuid}/scaleoutstatus/detail
GET
GET /virtualservice/{uuid}/ssopolicystats
GET
GET /virtualservice/{uuid}/icapstats
GET
GET /virtualservice/{uuid}/outofbandstats
GET
GET /virtualservice/{uuid}/botstats
GET
GET /virtualservice/{uuid}/placement/summary
GET
GET /virtualservice/{uuid}/placement/detail
GET
GET /virtualservice/{uuid}/placement/status