Put Ui Plugin

Put Ui Plugin

Update the plugin metadata for this extension clobbering existing information and returns the updated plugin metadata

Request
URI
PUT
https://{api_host}/cloudapi/extensions/ui/{id}
COPY
Path Parameters
string
id
Required

id

string
id
Required

id

Request Body
UiPluginMetadata of type(s) application/json
Optional 
{
    "pluginName": "string",
    "vendor": "string",
    "description": "string",
    "version": "string",
    "license": "string",
    "link": "string",
    "tenant_scoped": false,
    "provider_scoped": false,
    "enabled": false
}
string
pluginName
Required

Name of the UI Plugin

string
vendor
Required

Name of the vendor

string
description
Optional

Short description of the UI Plugin purpose

string
version
Required

Version of the UI Plugin following format major.minor.patch

string
license
Required

License of the UI Plugin

string
link
Required

Link to vendor's home page or other

boolean
tenant_scoped
Optional

Indicates if the UI Plugin is available in tenant portal

boolean
provider_scoped
Optional

Indicates if the UI Plugin is available in provider portal

boolean
enabled
Optional

Controls whether UI Plugin is available for provider and tenants

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns UiPluginMetadataResponse of type(s) application/json;version=38.1
This response body class contains all of the following: UiPluginMetadata , UploadMetadataResponse 
{
    "pluginName": "string",
    "vendor": "string",
    "description": "string",
    "version": "string",
    "license": "string",
    "link": "string",
    "tenant_scoped": false,
    "provider_scoped": false,
    "enabled": false,
    "id": "string",
    "plugin_status": "string",
    "resourcePath": "string"
}

Availability
Added in 30.0
On This Page
Ui Plugin Operations
DELETE
Delete Ui Plugin
GET
Get Extension Point Summary
GET
Get Ui Plugin
PUT
Put Extension Point Summary
PUT
Put Ui Plugin