SIsigmacomputing
plugins

Create a plugin

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.
post/v2/plugins

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Request body

namestring required

Display name of the plugin.

descriptionstring nullable

Description of the plugin.

devUrlstring nullable

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.

urlstring

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 required

Unique identifier (UUID) of the plugin.

namestring required

Display name of the plugin.

descriptionstring nullable required

Description of the plugin.

urlstring required

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 nullable required

Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode.

type'element' required

Changes

No recorded changes to this operation across all 1 revision of this API.