Plugin

Install a plugin package

Changed on

Upload a plugin zip. The package is loaded but not enabled.

post/v1/plugins

Request

  • Base URL: https://example.com/api
  • URL: https://example.com/api/v1/plugins
  • Auth: OAuth 2 (authorization code, authorization URL /oauth/authorize, token URL /oauth/token; client credentials, token URL /oauth/token; password, token URL /oauth/token, scopes: plugin)

Response

Created

idstring required

Installation row ID.

plugin_idstring required

Reverse-domain plugin identifier.

namestring required
versionstring required
status'unknown' | 'installed' | 'starting' | 'active' | 'disabling' | 'disabled' | 'failed' required

Lifecycle state of a plugin installation or runtime instance.

capabilitiesPluginCapability[] required
slotsPluginUISlot[] required
errorstring

Last runtime error, if the plugin failed to start.

enabledboolean nullable

Scoped activation when listing for a manage scope.

configobject

Per-activation config when listing for a manage scope.

created_atstring date-time required
updated_atstring date-time nullable

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "plugin_id": "com.elemo.timetracking",
  "name": "Time Tracking",
  "version": "1.0.0"
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      endpoint added