[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update External Service

Description

Update an external service. Vendor, name and version cannot be updated.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/extensions/api/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Request Body

Request Body

ExternalService of type(s) application/json Required
{
	"enabled": false,
	"name": "string",
	"vendor": "VMware",
	"version": "1.0.0"
}
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
Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns ExternalService of type(s) application/json;version=36.3
{
	"authorizationEnabled": false,
	"description": "string",
	"enabled": false,
	"id": "urn:vcloud:extension:VMware.Timer:1.0.0",
	"mqttTopics": {
		"key": "string"
	},
	"name": "string",
	"priority": 0,
	"vendor": "VMware",
	"version": "1.0.0"
}
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

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"authorizationEnabled":false,"description":"string","enabled":false,"id":"urn:vcloud:extension:VMware.Timer:1.0.0","mqttTopics":{"key":"string"},"name":"string","priority":0,"vendor":"VMware","version":"1.0.0"}' https://{api_host}/cloudapi/extensions/api/{id}


[{"label":"Latest (v36.3)","version":"latest"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?