Skip to main content

Create a plugin

POST 

/api/v1/plugins

Create a new plugin

Request

Body

required
    blob stringrequired

    The raw source code of the plugin. This should be an .html file

    contexts object[]required

    Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }

  • Array [
  • ]
  • description string

    Description of the plugin

    isDraft booleanrequired

    Whether the plugin is generally available or not

    minimumRoleRequired stringrequired

    Possible values: [VIEWER, USER, MANAGER, API, OWNER]

    The minimum role required to see the plugin, e.g. USER

    name stringrequired

    Display name of the plugin

    proxyTag string

    The identifier of the proxy to use for requests from this plugin

    tag stringrequired

    Unique identifier for the plugin

Responses

Metadata of the created plugin

Schema
    contexts object[]required

    Which contexts the plugin should execute/show up in, e.g. { "type": "GLOBAL" }

  • Array [
  • ]
  • createdBy object

    The creator of the plugin. Null if created via API.

    dateCreated date-timerequired
    email stringrequired
    id int64
    name stringrequired
    oauthUserId stringrequired
    tenantId int64required
    description string

    Description of the plugin

    isDraft booleanrequired

    Whether the plugin is generally available or not

    lastUpdated date-timerequired

    When the plugin was last updated

    minimumRoleRequired stringrequired

    Possible values: [VIEWER, USER, MANAGER, API, OWNER]

    The minimum role required to see the plugin, e.g. USER

    name stringrequired

    Display name of the plugin

    proxyTag string

    The identifier of the proxy to use for requests from this plugin

    tag stringrequired

    Unique identifier for the plugin

Loading...