[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

SddcEndpoint

An available network connections exposed by the SDDC


Properties

string as uri
endpoint Optional

A network endpoint that the SDDC exposes for communication.Deprecated in Api 35.0.


string
id Optional

boolean
isDefault Optional

True if this is the default endpoint for the parent SDDC. An endpoint being the default for the SDDC means that this endpoint’s target will be launched when the SDDC tile is clicked in the H5 Tenant UI of VCD.


string
name Optional

This is a required property.


proxy Optional

A reference to an optional Proxy that can be used to establish a connection to the endpoint


string
proxyId Optional

An optional identifier to a Proxy that can be used to establish a connection to the endpoint. Deprecated in Api 35.0 and replaced by proxy.


sddc Optional

The EntityReference of the parent SDDC entity. This is a required property to create the endpoint and once set cannot be edited.


string as uri
targetUrl Optional

The URL target of the SDDC endpoint. This is the URL that the browser tab will be pointed to when the endpoint is launched via the H5 UI of VCD. This is a required property.

JSON Example

{
	"endpoint": "string",
	"id": "string",
	"isDefault": false,
	"name": "SDDC Endpoint Sample Name",
	"proxy": {
		"id": "string",
		"name": "string"
	},
	"proxyId": "string",
	"sddc": {
		"id": "string",
		"name": "string"
	},
	"targetUrl": "https://sampleVc.vmware.com/ui"
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
    endpoint:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSortable
            - constraint: NonSearchable
        x-vcloud-deprecated-alternative: targetUrl
        x-vcloud-deprecated-in: "35.0"
    id:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - constraint: NonSortable
            - constraint: NonSearchable
            - args:
                - arg: sddcEndpoint
              constraint: Urn
    isDefault:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - constraint: NonSortable
    name:
        x-vcloud-added-in: "35.0"
    proxy:
        x-vcloud-added-in: "35.0"
    proxyId:
        x-vcloud-constraints:
            - constraint: ReadOnly
            - constraint: NonSortable
            - constraint: NonSearchable
            - args:
                - arg: proxy
              constraint: Urn
        x-vcloud-deprecated-alternative: proxy
        x-vcloud-deprecated-in: "35.0"
    sddc:
        x-vcloud-added-in: "35.0"
    targetUrl:
        x-vcloud-added-in: "35.0"
        x-vcloud-constraints:
            - constraint: NonSortable
            - constraint: NonSearchable
[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 33.0
Property Of

InlineSddcEndpoints1
Sddc
Parameter To

Create SDDC Endpoint
Update SDDC Endpoint
Returned By

Create SDDC Endpoint
Get SDDC Endpoint
Update SDDC Endpoint

Feedback

Was this page helpful?