SIsigmacomputing
plugins

Update a plugin

Update metadata fields on an existing 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 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.
patch/v2/plugins/{pluginId}

Request

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

Path parameters

pluginIdstring required

Unique identifier (UUID) of the plugin.

Request body

namestring

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.

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.