Update Sddc Endpoint | VMware Cloud Director OpenAPI

Update Sddc Endpoint

Update a specific SDDC endpoint.

Request

URI

PUT

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

COPY

Path Parameters

string

Required

SDDC Endpoint ID URN

string

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

Optional

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.

ApiKeyAuth

Responses

200

Returns SddcEndpoint of type(s) application/json;version=37.0

{
    "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

Optional

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

Availability