External Endpoint APIs

External Endpoint APIs

Provides APIs for managing external endpoints. External Endpoints are an addition to the API extensibility framework which allows VCD to act as a HTTP proxy to external endpoints - custom URL requests are directly redirected via HTTP to an external endpoint. The API extensibility over HTTP framework gives service providers the power to extend the standard API included with VCD. Service providers can register a URL pattern that, when called, the request will be redirected via HTTP to a configured external endpoint and the response from that endpoint will be returned back to the user as a response to the request. Essentially VCD acts like a transparent HTTP proxy. The external URL which requests will be proxied to must be an HTTPs URL and is part of the definition of the External Endpoint under "rootUrl": { "id": "urn:vcloud:extensionEndpoint:vmware:endpointName:1.0.0" "name": "endpointName", "version": "1.0.0", "vendor": "vmware", "rootUrl": "https://externalHost.com", "enabled": true, "authorizationEnabled": false }

If high performance is a requirement, API extensibility over MQTT would be a better fit, however this would require having an MQTT extension for processing HTTP requests.

Operations
POST
Create External Endpoint
Create external endpoint.
DELETE
Delete External Endpoint
Delete an external endpoint.
GET
Get External Endpoint
Retrieve an external endpoint.
GET
Get External Endpoints
Query external endpoints.
PUT
Update External Endpoint
Update an external endpoint.