---
title: "Create a plugin"
method: POST
path: "/v2/plugins"
tags: ["plugins"]
---

# Create a plugin

`POST /v2/plugins`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/plugins`
- Auth: HTTP bearer

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.

## Request body

- object
  - `name` string, required: Display name of the plugin.
  - `description` string, nullable: Description of the plugin.
  - `devUrl` string, 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.
  - `url` string: 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 `200`

The response body.

- PluginsCreateCustomPluginResponse200
  - `pluginId` string, required: Unique identifier (UUID) of the plugin.
  - `name` string, required: Display name of the plugin.
  - `description` string, nullable, required: Description of the plugin.
  - `url` string, 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.
  - `devUrl` string, nullable, required: Development URL for the plugin. Sigma loads the plugin from this URL when the plugin runs in development mode.
  - `type` 'element', required

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)