ExternalEndpoint

ExternalEndpoint
ExternalEndpoint

External endpoints are part of the API extensibility framework. They allow requests to be directly proxied over HTTP to an external endpoint.

JSON Example 
{
    "name": "string",
    "id": "urn:vcloud:externalEndpoint:vendor.name:1.0.0",
    "version": "1.0.0",
    "vendor": "VMware",
    "enabled": false,
    "description": "string",
    "rootUrl": "https://externalHost"
}
string
name
Required

The name of the external endpoint.

string
id
Optional

The unique id of the external endpoint.

string
version
Required

The external endpoint's version. The version should follow semantic versioning rules. Versions with pre-release extension are not allowed. The combination of vendor-namespace-version must be unique.

string
vendor
Required

The vendor name. The combination of vendor-namespace-version must be unique.

boolean
enabled
Required

Whether the external endpoint is enabled or not.

string
description
Optional

description

string
rootUrl
Required

The external endpoint which requests will be redirected to. The rootUrl must be a valid URL of https protocol.

Availability
Added in 37.3
Parameter To
Returned By