GET /vsgs

GET /vsgs

/vsgs

Request
URI
GET
https://{api_host}/api/vsgs
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= : . Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

string
referred_by
Optional

Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by= : . Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

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.

Responses
200

OK

Returns VsGsApiResponse of type(s) application/json 
{
    "count": 0,
    "results": [
        {
            "_last_modified": "string",
            "configpb_attributes": {
                "version": 0
            },
            "geodb_uuid": "string",
            "gs_uuid": "string",
            "gslb_uuid": "string",
            "name": "string",
            "tenant_ref": "string",
            "type": "string",
            "url": "string",
            "uuid": "string",
            "vs_uuid": "string"
        }
    ],
    "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/vsgs
On This Page
Vs Gs Operations
GET
GET /vsgs
POST
POST /vsgs
GET
GET /vsgs/{uuid}
PUT
PUT /vsgs/{uuid}
PATCH
PATCH /vsgs/{uuid}
DELETE
DELETE /vsgs/{uuid}