Create External Service

Create an external service. Once created, the combination of vendor, name and version cannot be modified and must be unique. Each extension will have its own MQTT topics.

Request

URI

POST

https://{api_host}/cloudapi/extensions/api

COPY

Request Body

ExternalService of type(s) application/json

Optional

{
    "name": "string",
    "id": "urn:vcloud:extension:VMware.Timer:1.0.0",
    "version": "1.0.0",
    "vendor": "VMware",
    "priority": 0,
    "enabled": false,
    "authorizationEnabled": false,
    "description": "string",
    "mqttTopics": {
        "mqttTopics": "string"
    }
}

string

name

Required

The name of the external service.

string

Optional

The unique id of the external service.

string

version

Required

The extension'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.

integer As int32 As int32

priority

Optional

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

boolean

enabled

Required

Whether the extension is enabled or not.

boolean

authorizationEnabled

Optional

Whether authorization is enabled for the service.

string

description

Optional

description

object

mqttTopics

Optional

The map of MQTT topics this extension will communicate through.

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Returns ExternalService of type(s) application/json;version=39.0

{
    "name": "string",
    "id": "urn:vcloud:extension:VMware.Timer:1.0.0",
    "version": "1.0.0",
    "vendor": "VMware",
    "priority": 0,
    "enabled": false,
    "authorizationEnabled": false,
    "description": "string",
    "mqttTopics": {
        "mqttTopics": "string"
    }
}

string

name

Required

The name of the external service.

string

Optional

The unique id of the external service.

string

version

Required

The extension'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.

integer As int32 As int32

priority

Optional

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

boolean

enabled

Required

Whether the extension is enabled or not.