ExternalService

The central concept in vCD API extensibility framework. It serves as a namespace for all other objects and holds top level settings like - enable/disable and API filters.


Properties

string
vendor Required

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


boolean
enabled Required

Whether the extension is enabled or not.


string
name Required

The name of the external service.


string
version Required

The extension’s version. The version should follow semantic versioning rules. The combination of vendor-namespace-version must be unique.


boolean
authorizationEnabled Optional

Whether authorization is enabled for the service.


string
id Optional

The unique id of the external service.


map of string
mqttTopics Optional

The map of MQTT topics this extension will communicate through.


integer as int32
priority Optional

Extension service priority. An integer between 0-100. A value of 50 denotes a neutral priority.


string
description Optional
Description not available

JSON Example

{
    "enabled": false,
    "name": "string",
    "vendor": "VMware",
    "version": "1.0.0"
}
Feedback

Was this page helpful?