Sigma REST APIPlugins{pluginId}

Update a plugin

View as Markdown
Update metadata fields on an existing custom plugin. Only fields included in the request are changed. The `url` field cannot be updated by this endpoint. ### Usage notes - Retrieve the **pluginId** by calling the [/v2/plugins](https://help.sigmacomputing.com/reference/list-custom-plugins) endpoint. - To perform this operation, you must use API credentials owned by a user assigned the Admin account type or an account type with the **Manage plugins** permission enabled.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

pluginIdstringRequired

Unique identifier (UUID) of the custom plugin.

Request

The request body.
namestringOptional
Display name of the plugin.
descriptionstring or nullOptional
Description of the plugin.
devUrlstring or nullOptional
Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode.

Response

The response body.
pluginIdstring

Unique identifier (UUID) of the plugin.

namestring
Display name of the plugin.
descriptionstring or null
Description of the plugin.
urlstring
Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. An empty string indicates that no production URL has been set for the plugin yet.
devUrlstring or null
Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode.
typeenum