Avi DynamicDnsRecord Object API
CLI ``` - show dynamicdnsrecord ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /dynamicdnsrecordpost /dynamicdnsrecorddelete /dynamicdnsrecord/{uuid}get /dynamicdnsrecord/{uuid}patch /dynamicdnsrecord/{uuid}put /dynamicdnsrecord/{uuid}
(dynamicdnsrecordGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
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
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"ip6_address" : [ {
"ip6_address" : {
"addr" : "aeiou",
"type" : "aeiou"
}
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : "aeiou",
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"dns_vs_uuid" : "aeiou",
"cname" : {
"cname" : "aeiou"
},
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"delegated" : true,
"service_locators" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"algorithm" : "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.
Responses
200
OK
DynamicDnsRecordApiResponse
401
log in failed
Up
post /dynamicdnsrecord
(dynamicdnsrecordPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — DynamicDnsRecord object creation
Return type
Example data
Content-Type: application/json
{
"ip6_address" : [ {
"ip6_address" : {
"addr" : "aeiou",
"type" : "aeiou"
}
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : "aeiou",
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"dns_vs_uuid" : "aeiou",
"cname" : {
"cname" : "aeiou"
},
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"delegated" : true,
"service_locators" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"algorithm" : "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.
Responses
200
OK
DynamicDnsRecord
401
log in failed
Up
delete /dynamicdnsrecord/{uuid}
(dynamicdnsrecordUuidDelete)
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:
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.
Responses
204
object deleted
String
404
not found
Up
get /dynamicdnsrecord/{uuid}
(dynamicdnsrecordUuidGet)
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:
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
Example data
Content-Type: application/json
{
"ip6_address" : [ {
"ip6_address" : {
"addr" : "aeiou",
"type" : "aeiou"
}
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : "aeiou",
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"dns_vs_uuid" : "aeiou",
"cname" : {
"cname" : "aeiou"
},
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"delegated" : true,
"service_locators" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"algorithm" : "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.
Responses
200
OK
DynamicDnsRecord
401
log in failed
Up
patch /dynamicdnsrecord/{uuid}
(dynamicdnsrecordUuidPatch)
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:
Request body
body (required)
Body Parameter — DynamicDnsRecord object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"ip6_address" : [ {
"ip6_address" : {
"addr" : "aeiou",
"type" : "aeiou"
}
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : "aeiou",
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"dns_vs_uuid" : "aeiou",
"cname" : {
"cname" : "aeiou"
},
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"delegated" : true,
"service_locators" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"algorithm" : "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.
Responses
200
OK
DynamicDnsRecord
401
log in failed
Up
put /dynamicdnsrecord/{uuid}
(dynamicdnsrecordUuidPut)
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:
Request body
body (required)
Body Parameter — DynamicDnsRecord object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"ip6_address" : [ {
"ip6_address" : {
"addr" : "aeiou",
"type" : "aeiou"
}
} ],
"mx_records" : [ {
"host" : "aeiou",
"priority" : 123
} ],
"metadata" : "aeiou",
"fqdn" : "aeiou",
"ns" : [ {
"ip6_address" : "",
"ip_address" : "",
"nsname" : "aeiou"
} ],
"dns_vs_uuid" : "aeiou",
"cname" : {
"cname" : "aeiou"
},
"description" : "aeiou",
"ip_address" : [ {
"ip_address" : ""
} ],
"type" : "aeiou",
"ttl" : 123,
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"wildcard_match" : true,
"txt_records" : [ {
"text_str" : "aeiou"
} ],
"num_records_in_response" : 123,
"tenant_ref" : "aeiou",
"name" : "aeiou",
"delegated" : true,
"service_locators" : [ {
"port" : 123,
"weight" : 123,
"priority" : 123,
"target" : "aeiou"
} ],
"algorithm" : "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.
Responses
200
OK
DynamicDnsRecord
401
log in failed
[ Jump to Methods ]
Table of Contents
DnsAAAARdataDnsARdataDnsCnameRdataDnsMxRdataDnsNsRdataDnsSrvRdataDnsTxtRdataDynamicDnsRecordDynamicDnsRecordApiResponseIpAddr
ip6_address
IpAddr IPv6 address for FQDN. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_address
IpAddr IP address for FQDN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
cname
String Canonical name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
host
String Fully qualified domain name of a mailserver . The host name maps directly to one or more address records in the DNS table, and must not point to any CNAME records (RFC 2181). Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
priority
Integer The priority field identifies which mail server should be preferred. Allowed values are 0-65535. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
ip6_address (optional)
IpAddr IPv6 address for Name Server. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
ip_address (optional)
IpAddr IP address for Name Server. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
nsname
String Name Server name. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
port
Integer Service port. Allowed values are 0-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
priority (optional)
Integer Priority of the target hosting the service, low value implies higher priority for this service record. Allowed values are 0-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
target (optional)
String Canonical hostname, of the machine hosting the service, with no trailing period. 'default.host' is valid but not 'default.host.'. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
weight (optional)
Integer Relative weight for service records with same priority, high value implies higher preference for this service record. Allowed values are 0-65535. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32
text_str
String Text data associated with the FQDN. Field introduced in 18.2.9, 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
algorithm (optional)
String Specifies the algorithm to pick the IP address(es) to be returned,when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is round-robin. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
cname (optional)
DnsCnameRdata Canonical name in CNAME record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
delegated (optional)
Boolean Configured FQDNs are delegated domains (i.e. they represent a zone cut). Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
description (optional)
String Details of DNS record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
dns_vs_uuid (optional)
String UUID of the DNS VS. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
fqdn (optional)
String Fully Qualified Domain Name. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip6_address (optional)
array[DnsAAAARdata] IPv6 address in AAAA record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ip_address (optional)
array[DnsARdata] IP address in A record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
metadata (optional)
String Internal metadata for the DNS record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
mx_records (optional)
array[DnsMxRdata] MX record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name (optional)
String DynamicDnsRecord name, needed for a top level uuid protobuf, for display in shell. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ns (optional)
array[DnsNsRdata] Name Server information in NS record. Field introduced in 20.1.3. Maximum of 13 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
num_records_in_response (optional)
Integer Specifies the number of records returned by the DNS service.Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- Return all records. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
service_locators (optional)
array[DnsSrvRdata] Service locator info in SRV record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String tenant_uuid from Dns VS's tenant_uuid. It is a reference to an object of type Tenant. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ttl (optional)
Integer Time To Live for this DNS record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. format: int32
txt_records (optional)
array[DnsTxtRdata] Text record. Field introduced in 20.1.3. Maximum of 4 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
type (optional)
String DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String UUID of the dns record. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
wildcard_match (optional)
Boolean Enable wild-card match of fqdn if an exact match is not found in the DNS table, the longest match is chosen by wild-carding the fqdn in the DNS request. Default is false. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
addr
String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
type
String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.