GET /geodb/{uuid}

GET /geodb/{uuid}

/geodb/{uuid}

Request
URI
GET
https://{api_host}/api/geodb/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

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 GeoDB of type(s) application/json 
{
    "_last_modified": "string",
    "description": "string",
    "files": [
        {
            "enabled": false,
            "file_ref": "string",
            "index": 0,
            "name": "string",
            "vendor": "string"
        }
    ],
    "is_federated": false,
    "mappings": [
        {
            "description": "string",
            "elements": [
                {
                    "attribute": "string",
                    "values": [
                        "string"
                    ]
                }
            ],
            "name": "string"
        }
    ],
    "name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

string
description
Optional

Description. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
files
Optional

Geo Database files. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
is_federated
Optional

This field indicates that this object is replicated across GSLB federation. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
mappings
Optional

Custom mappings of geo values. All mappings which start with the prefix 'System-' (any case) are reserved for system default objects and may be overwritten. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Geo Database name. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of this object. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/api/geodb/{uuid}
On This Page
Geo Db Operations
GET
GET /geodb
POST
POST /geodb
GET
GET /geodb/{uuid}
PUT
PUT /geodb/{uuid}
PATCH
PATCH /geodb/{uuid}
DELETE
DELETE /geodb/{uuid}
GET
GET /geodb/{uuid}/runtime/internal/