GET /ipamdnsproviderprofile/{uuid}

GET /ipamdnsproviderprofile/{uuid}

/ipamdnsproviderprofile/{uuid}

Request
URI
GET
https://{api_host}/api/ipamdnsproviderprofile/{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 IpamDnsProviderProfile of type(s) application/json
{
    "_last_modified": "string",
    "allocate_ip_in_vrf": false,
    "aws_profile": {
        "access_key_id": "string",
        "egress_service_subnets": [
            "string"
        ],
        "iam_assume_role": "string",
        "publish_vip_to_public_zone": false,
        "region": "string",
        "secret_access_key": "string",
        "ttl": 0,
        "usable_domains": [
            "string"
        ],
        "usable_network_uuids": [
            "string"
        ],
        "use_iam_roles": false,
        "vpc": "string",
        "vpc_id": "string",
        "zones": [
            {
                "availability_zone": "string",
                "usable_network_uuids": [
                    "string"
                ]
            }
        ]
    },
    "azure_profile": {
        "azure_serviceprincipal": {
            "application_id": "string",
            "authentication_token": "string",
            "tenant_id": "string"
        },
        "azure_userpass": {
            "password": "string",
            "tenant_name": "string",
            "username": "string"
        },
        "egress_service_subnets": [
            "string"
        ],
        "resource_group": "string",
        "subscription_id": "string",
        "usable_domains": [
            "string"
        ],
        "usable_network_uuids": [
            "string"
        ],
        "use_enhanced_ha": false,
        "use_standard_alb": false,
        "virtual_network_ids": [
            "string"
        ]
    },
    "configpb_attributes": {
        "version": 0
    },
    "custom_profile": {
        "custom_ipam_dns_profile_ref": "string",
        "dynamic_params": [
            {
                "is_dynamic": false,
                "is_sensitive": false,
                "name": "string",
                "value": "string"
            }
        ],
        "usable_alloc_subnets": [
            {
                "network_id": "string",
                "subnet": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                },
                "subnet6": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            }
        ],
        "usable_domains": [
            "string"
        ]
    },
    "gcp_profile": {
        "match_se_group_subnet": false,
        "network_host_project_id": "string",
        "region_name": "string",
        "se_project_id": "string",
        "usable_network_refs": [
            "string"
        ],
        "use_gcp_network": false,
        "vpc_network_name": "string"
    },
    "infoblox_profile": {
        "dns_view": "string",
        "extensible_attributes": [
            {
                "is_dynamic": false,
                "is_sensitive": false,
                "name": "string",
                "value": "string"
            }
        ],
        "ip6_address": {
            "addr": "string",
            "type": "string"
        },
        "ip_address": {
            "addr": "string",
            "type": "string"
        },
        "network_view": "string",
        "password": "string",
        "profile_url": "string",
        "usable_alloc_subnets": [
            {
                "subnet": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                },
                "subnet6": {
                    "ip_addr": {
                        "addr": "string",
                        "type": "string"
                    },
                    "mask": 0
                }
            }
        ],
        "usable_domains": [
            "string"
        ],
        "username": "string",
        "wapi_version": "string"
    },
    "internal_profile": {
        "dns_service_domain": [
            {
                "domain_name": "string",
                "pass_through": false,
                "record_ttl": 0
            }
        ],
        "dns_virtualservice_ref": "string",
        "ttl": 0,
        "usable_networks": [
            {
                "labels": [
                    {
                        "key": "string",
                        "value": "string"
                    }
                ],
                "nw_ref": "string"
            }
        ]
    },
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "oci_profile": {
        "cloud_credentials_ref": "string",
        "region": "string",
        "tenancy": "string",
        "vcn_compartment_id": "string",
        "vcn_id": "string"
    },
    "openstack_profile": {
        "keystone_host": "string",
        "password": "string",
        "region": "string",
        "tenant": "string",
        "username": "string",
        "vip_network_name": "string"
    },
    "proxy_configuration": {
        "host": "string",
        "password": "string",
        "port": 0,
        "username": "string"
    },
    "tenant_ref": "string",
    "tencent_profile": {
        "cloud_credentials_ref": "string",
        "region": "string",
        "usable_subnet_ids": [
            "string"
        ],
        "vpc_id": "string",
        "zones": [
            {
                "availability_zone": "string",
                "usable_subnet_id": "string"
            }
        ]
    },
    "type": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

boolean
allocate_ip_in_vrf
Optional

If this flag is set, only allocate IP from networks in the Virtual Service VRF. Applicable for Avi Vantage IPAM only. Field introduced in 17.2.4. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
aws_profile
Optional

aws_profile

object
azure_profile
Optional

azure_profile

object
configpb_attributes
Optional

configpb_attributes

object
custom_profile
Optional

custom_profile

object
gcp_profile
Optional

gcp_profile

object
infoblox_profile
Optional

infoblox_profile

object
internal_profile
Optional

internal_profile

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Name for the IPAM/DNS Provider profile. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
oci_profile
Optional

oci_profile

object
openstack_profile
Optional

openstack_profile

object
proxy_configuration
Optional

proxy_configuration

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

object
tencent_profile
Optional

tencent_profile

string
type
Required

Provider Type for the IPAM/DNS Provider profile. Enum options - IPAMDNS_TYPE_INFOBLOX, IPAMDNS_TYPE_AWS, IPAMDNS_TYPE_OPENSTACK, IPAMDNS_TYPE_GCP, IPAMDNS_TYPE_INFOBLOX_DNS, IPAMDNS_TYPE_CUSTOM, IPAMDNS_TYPE_CUSTOM_DNS, IPAMDNS_TYPE_AZURE, IPAMDNS_TYPE_OCI, IPAMDNS_TYPE_TENCENT, IPAMDNS_TYPE_INTERNAL, IPAMDNS_TYPE_INTERNAL_DNS, IPAMDNS_TYPE_AWS_DNS, IPAMDNS_TYPE_AZURE_DNS. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- IPAMDNS_TYPE_INTERNAL), Basic edition(Allowed values- IPAMDNS_TYPE_INTERNAL), Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the IPAM/DNS Provider profile. Allowed in Enterprise edition with any value, Essentials, Basic, 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/ipamdnsproviderprofile/{uuid}