Update Sddc Endpoint

Update Sddc Endpoint

Update a specific SDDC endpoint.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/endpoints/{id}
COPY
Path Parameters
string
id
Required

SDDC Endpoint ID URN

string
id
Required

SDDC Endpoint ID URN

Request Body

The updated SDDC endpoint model.

SddcEndpoint of type(s) application/json
Required 
{
    "name": "SDDC Endpoint Sample Name",
    "id": "string",
    "endpoint": "string",
    "proxyId": "string",
    "targetUrl": "https://sampleVc.vmware.com/ui",
    "proxy": {
        "name": "string",
        "id": "string"
    },
    "sddc": {
        "name": "string",
        "id": "string"
    },
    "isDefault": false
}
string
name
Optional

This is a required property.

string
id
Optional

id

string As uri As uri
endpoint
Optional

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

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.

string As uri 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.

EntityReference
proxy
Optional

proxy

EntityReference
sddc
Optional

sddc

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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SddcEndpoint of type(s) application/json;version=36.3 
{
    "name": "SDDC Endpoint Sample Name",
    "id": "string",
    "endpoint": "string",
    "proxyId": "string",
    "targetUrl": "https://sampleVc.vmware.com/ui",
    "proxy": {
        "name": "string",
        "id": "string"
    },
    "sddc": {
        "name": "string",
        "id": "string"
    },
    "isDefault": false
}
string
name
Optional

This is a required property.

string
id
Optional

id

string As uri As uri
endpoint
Optional

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

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.

string As uri 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.

EntityReference
proxy
Optional

proxy

EntityReference
sddc
Optional

sddc

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.


Availability
Added in 35.0
On This Page
Sddcs Operations
POST
Create Sddc
POST
Create Sddc Endpoint
DELETE
Delete Sddc
DELETE
Delete Sddc Endpoint
GET
Get Endpoints For Sddc
GET
Get Proxies For Sddc
GET
Get Sddc
GET
Get Sddc Endpoint
GET
Get Sddc Owner
GET
Get Sddcs
GET
Query Sddc Tenants
POST
Sddc Publish To Tenants
POST
Sddc Unpublish From Tenants
PUT
Set Sddc Owner
PUT
Set Sddc Tenants
PUT
Update Sddc
PUT
Update Sddc Endpoint