Create External Endpoint

Create External Endpoint

Creates an external endpoint. Vendor, name and version cannot be modified post-creation and must be unique. Each external endpoint will proxy its' requests to the configured rootUrl.

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/externalEndpoints
COPY
Request Body
ExternalEndpoint of type(s) application/json
Optional 
{
    "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.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ExternalEndpoint of type(s) application/json;version=37.3 
{
    "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
On This Page
External Endpoint Operations
POST
Create External Endpoint
DELETE
Delete External Endpoint
GET
Get External Endpoint
GET
Get External Endpoints
PUT
Update External Endpoint