Sigma REST APIPlugins{pluginId}

Get a plugin

View as Markdown
Get the metadata for a plugin by its ID. ### Usage notes - Retrieve the **pluginId** by calling the [/v2/plugins](https://help.sigmacomputing.com/reference/list-custom-plugins) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

pluginIdstringRequired

Unique identifier (UUID) of the custom plugin.

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