Skip to main content
PUT
/
plugin
/
{id}
cURL
curl --request PUT \
  --url http://127.0.0.1:3000/api/plugin/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "positions": [
    "dashboard"
  ],
  "description": "<string>",
  "detailDesc": "<string>",
  "url": "<string>",
  "config": {
    "contextMenu": {
      "width": 123,
      "height": 123,
      "x": 123,
      "y": 123,
      "frozenResize": true,
      "frozenDrag": true
    },
    "view": "<unknown>",
    "dashboard": "<unknown>",
    "panel": "<unknown>"
  },
  "logo": "<string>",
  "helpUrl": "<string>",
  "i18n": {
    "en": {
      "title": "Plugin title",
      "description": "Plugin description"
    },
    "zh": {
      "title": "插件标题",
      "description": "插件描述"
    }
  }
}
'
{
  "id": "<string>",
  "name": "<string>",
  "logo": "<string>",
  "positions": [
    "dashboard"
  ],
  "secret": "<string>",
  "status": "developing",
  "createdTime": "<string>",
  "lastModifiedTime": "<string>",
  "description": "<string>",
  "detailDesc": "<string>",
  "config": {
    "contextMenu": {
      "width": 123,
      "height": 123,
      "x": 123,
      "y": 123,
      "frozenResize": true,
      "frozenDrag": true
    },
    "view": "<unknown>",
    "dashboard": "<unknown>",
    "panel": "<unknown>"
  },
  "url": "<string>",
  "helpUrl": "<string>",
  "i18n": {
    "en": {
      "title": "Plugin title",
      "description": "Plugin description"
    },
    "zh": {
      "title": "插件标题",
      "description": "插件描述"
    }
  },
  "pluginUser": {
    "id": "<string>",
    "name": "<string>",
    "email": "[email protected]",
    "avatar": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
name
string
required
​
positions
enum<string>[]
required
Minimum array length: 1
Available options:
dashboard,
view,
contextMenu,
panel
​
description
string
Maximum string length: 150
​
detailDesc
string
Maximum string length: 3000
​
url
string<uri>
​
config
object
​
helpUrl
string<uri>
​
i18n
object
Example:
{
  "en": {
    "title": "Plugin title",
    "description": "Plugin description"
  },
  "zh": { "title": "插件标题", "description": "插件描述" }
}

Response

200 - application/json

Returns data about the plugin.

​
id
string
required
​
name
string
required
​
positions
enum<string>[]
required
Available options:
dashboard,
view,
contextMenu,
panel
​
secret
string
required
​
status
enum<string>
required
Available options:
developing,
reviewing,
published
​
createdTime
string
required
​
lastModifiedTime
string
required
​
description
string
​
detailDesc
string
​
config
object
​
url
string
​
helpUrl
string
​
i18n
object
Example:
{
  "en": {
    "title": "Plugin title",
    "description": "Plugin description"
  },
  "zh": { "title": "插件标题", "description": "插件描述" }
}
​
pluginUser
object
Last modified on December 10, 2025