Sigma REST APIPlugins

Create a plugin

View as Markdown
Register a new plugin in the organization. If `url` is omitted, the plugin is created with an empty production URL, and Sigma cannot load the plugin in workbooks until one is set. ### Usage notes - 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>.

Request

The request body.
namestringRequired
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. Defaults to http://localhost:5173 if omitted.

urlstringOptional
Production URL where the plugin is hosted. Sigma loads the plugin from this URL when it is added to a workbook. If omitted, the plugin is created with an empty URL.

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