POST
/
plugin
curl --request POST \
  --url https://app.teable.io/api/plugin \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"name":"string","description":"string","detailDesc":"string","logo":"string","url":"http://example.com","helpUrl":"http://example.com","positions":["dashboard"],"i18n":{"en":{"title":"Plugin title","description":"Plugin description"},"zh":{"title":"插件标题","description":"插件描述"}}}'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "detailDesc": "<string>",
  "logo": "<string>",
  "url": "<string>",
  "helpUrl": "<string>",
  "positions": [
    "dashboard"
  ],
  "i18n": {
    "en": {
      "title": "Plugin title",
      "description": "Plugin description"
    },
    "zh": {
      "title": "插件标题",
      "description": "插件描述"
    }
  },
  "secret": "<string>",
  "status": "developing",
  "pluginUser": {
    "id": "<string>",
    "name": "<string>",
    "email": "jsmith@example.com",
    "avatar": "<string>"
  },
  "createdTime": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
Required string length: 1 - 20
positions
enum<string>[]
required
Available options:
dashboard,
view,
float
description
string
Maximum length: 150
detailDesc
string
Maximum length: 3000
url
string
helpUrl
string
i18n
object

Response

201 - application/json
Returns data about the plugin.
id
string
required
name
string
required
positions
enum<string>[]
required
Available options:
dashboard,
view,
float
secret
string
required
status
enum<string>
required
Available options:
developing,
reviewing,
published
createdTime
string
required
description
string
detailDesc
string
url
string
helpUrl
string
i18n
object
pluginUser
object