NSX-T Data Center REST API

Read cluster virtual IP address

Returns the configured cluster virtual IP address or null if not configured.

Request:

Method:
GET
URI Path(s):
/api/v1/cluster/api-virtual-ip
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/cluster/api-virtual-ip

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterVirtualIpProperties+

Example Response:

{ "_schema": "ClusterVirtualIpProperties", "_self": { "href": "/cluster/api-virtual-ip", "rel": "self" }, "ip_address": 0.0.0.0 }

Required Permissions:

read

Feature:

cluster_management

Additional Errors: