[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"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

Update SDDC Endpoint

Description

Update a specific SDDC endpoint.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/endpoints/{id}
Copy

Path Parameters

Path Parameters

string
id Required

SDDC Endpoint ID URN


Request Body

Request Body

SddcEndpoint of type(s) application/json Required

The updated SDDC endpoint model.

{
    "name": "SDDC Endpoint Sample Name",
    "targetUrl": "https://sampleVc.vmware.com/ui"
}
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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns SddcEndpoint of type(s) application/json;version=36.3
{
    "name": "SDDC Endpoint Sample Name",
    "targetUrl": "https://sampleVc.vmware.com/ui"
}
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.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"name":"SDDC Endpoint Sample Name","targetUrl":"https://sampleVc.vmware.com/ui"}' https://{api_host}/cloudapi/1.0.0/endpoints/{id}


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"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
Feedback

Was this page helpful?