Avi GeoDB Object API

CLI ``` - configure geodb - show geodb - show geodb data ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 22.1.6

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /geodb
post /geodb
delete /geodb/{uuid}
get /geodb/{uuid}
patch /geodb/{uuid}
put /geodb/{uuid}
get /geodb/{uuid}/runtime/internal/

get /geodb

(geodbGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

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

GeoDBApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "mappings" : [ {
      "elements" : [ {
        "values" : [ "aeiou" ],
        "attribute" : "aeiou"
      } ],
      "name" : "aeiou",
      "description" : "aeiou"
    } ],
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "files" : [ {
      "vendor" : "aeiou",
      "name" : "aeiou",
      "index" : 123,
      "file_ref" : "aeiou",
      "enabled" : true
    } ],
    "uuid" : "aeiou",
    "is_federated" : true,
    "url" : "aeiou",
    "_last_modified" : "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.

application/json

Responses

200

OK GeoDBApiResponse

401

post /geodb

(geodbPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — GeoDB object creation

Return type

GeoDB

Example data

Content-Type: application/json

{
  "mappings" : [ {
    "elements" : [ {
      "values" : [ "aeiou" ],
      "attribute" : "aeiou"
    } ],
    "name" : "aeiou",
    "description" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "files" : [ {
    "vendor" : "aeiou",
    "name" : "aeiou",
    "index" : 123,
    "file_ref" : "aeiou",
    "enabled" : true
  } ],
  "uuid" : "aeiou",
  "is_federated" : true,
  "url" : "aeiou",
  "_last_modified" : "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.

application/json

Responses

200

OK GeoDB

401

delete /geodb/{uuid}

(geodbUuidDelete)

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:

application/json

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.

application/json

Responses

204

object deleted String

404

not found

get /geodb/{uuid}

(geodbUuidGet)

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:

application/json

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

GeoDB

Example data

Content-Type: application/json

{
  "mappings" : [ {
    "elements" : [ {
      "values" : [ "aeiou" ],
      "attribute" : "aeiou"
    } ],
    "name" : "aeiou",
    "description" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "files" : [ {
    "vendor" : "aeiou",
    "name" : "aeiou",
    "index" : 123,
    "file_ref" : "aeiou",
    "enabled" : true
  } ],
  "uuid" : "aeiou",
  "is_federated" : true,
  "url" : "aeiou",
  "_last_modified" : "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.

application/json

Responses

200

OK GeoDB

401

patch /geodb/{uuid}

(geodbUuidPatch)

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:

application/json

Request body

body (required)

Body Parameter — GeoDB object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

GeoDB

Example data

Content-Type: application/json

{
  "mappings" : [ {
    "elements" : [ {
      "values" : [ "aeiou" ],
      "attribute" : "aeiou"
    } ],
    "name" : "aeiou",
    "description" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "files" : [ {
    "vendor" : "aeiou",
    "name" : "aeiou",
    "index" : 123,
    "file_ref" : "aeiou",
    "enabled" : true
  } ],
  "uuid" : "aeiou",
  "is_federated" : true,
  "url" : "aeiou",
  "_last_modified" : "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.

application/json

Responses

200

OK GeoDB

401

put /geodb/{uuid}

(geodbUuidPut)

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:

application/json

Request body

body (required)

Body Parameter — GeoDB object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

GeoDB

Example data

Content-Type: application/json

{
  "mappings" : [ {
    "elements" : [ {
      "values" : [ "aeiou" ],
      "attribute" : "aeiou"
    } ],
    "name" : "aeiou",
    "description" : "aeiou"
  } ],
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "files" : [ {
    "vendor" : "aeiou",
    "name" : "aeiou",
    "index" : 123,
    "file_ref" : "aeiou",
    "enabled" : true
  } ],
  "uuid" : "aeiou",
  "is_federated" : true,
  "url" : "aeiou",
  "_last_modified" : "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.

application/json

Responses

200

OK GeoDB

401

get /geodb/{uuid}/runtime/internal/

(geodbUuidRuntimeInternalGet)

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:

application/json

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.

application/json

Responses

200

OK String

401

Models

[ Jump to Methods ]

GeoDB
GeoDBApiResponse
GeoDBFile
GeoDBMapping
GeoDBMappingElement

GeoDB Up

_last_modified (optional)

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

description (optional)

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

files (optional)

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

is_federated (optional)

Boolean 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.

mappings (optional)

array[GeoDBMapping] 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.

name

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

tenant_ref (optional)

String 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.

url (optional)

String url

uuid (optional)

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

GeoDBApiResponse Up

count

Integer format: int32

results

array[GeoDB]

next (optional)

String

GeoDBFile Up

enabled (optional)

Boolean If set to false, this file is ignored. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

file_ref

String The file object that contains the geo data. Must be of type 'GeoDB'. It is a reference to an object of type FileObject. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

index

Integer Priority of the file - larger number takes precedence. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32

name

String Name of the file. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

vendor

String Source of the file data. Enum options - VENDOR_USER_DEFINED, VENDOR_AVI_DEFINED. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

GeoDBMapping Up

description (optional)

String Description of the mapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

elements

array[GeoDBMappingElement] The set of mapping elements. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

name

String The unique name of the user mapping. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

GeoDBMappingElement Up

attribute

String The attribute to map. Enum options - ATTRIBUTE_IP_PREFIX, ATTRIBUTE_COUNTRY_CODE, ATTRIBUTE_COUNTRY_NAME, ATTRIBUTE_CONTINENT_CODE, ATTRIBUTE_CONTINENT_NAME, ATTRIBUTE_REGION_NAME, ATTRIBUTE_CITY_NAME, ATTRIBUTE_ISP_NAME, ATTRIBUTE_ORGANIZATION_NAME, ATTRIBUTE_AS_NUMBER, ATTRIBUTE_AS_NAME, ATTRIBUTE_LONGITUDE, ATTRIBUTE_LATITUDE, ATTRIBUTE_CUSTOM_1, ATTRIBUTE_CUSTOM_2, ATTRIBUTE_CUSTOM_3, ATTRIBUTE_CUSTOM_4, ATTRIBUTE_CUSTOM_5, ATTRIBUTE_CUSTOM_6, ATTRIBUTE_CUSTOM_7, ATTRIBUTE_CUSTOM_8, ATTRIBUTE_CUSTOM_9, ATTRIBUTE_USER_DEFINED_MAPPING. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

values

array[String] The values to map. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

Avi GeoDB Object API

Access

Methods

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Return type

Example data

Produces

Responses

200

401

Models

Table of Contents

GeoDB Up

GeoDBApiResponse Up

GeoDBFile Up

GeoDBMapping Up

GeoDBMappingElement Up