Plugins

Discovering which modules a deployment has, and the instance ids every plugin-scoped route needs.

Every path on this page is plugin-scoped: {pluginInstalledId} is the id of the module instance you are talking to, from Plugins. A deployment can run more than one instance of the same module, and the id is what tells them apart.

9 endpoints. Every one needs Authorization: Bearer <access token>; see Getting Started.

Permissions

The server authorises every call against the signed-in user's permission keys — the same keys the client is held to. For this module they are the PluginInstance* and PluginSetting* key families. See the Permission Keys reference.

Attributes

Method	Path	What it does
GET	plugin-instances/plugins/{pluginInstalledId}/attributes	Plugin instance attribute get all
PUT	plugin-instances/plugins/{pluginInstalledId}/attributes	Plugin instance attribute save all
GET	plugin-instances/plugins/{pluginInstalledId}/attributes/{attributeName}	Plugin instance attribute get
PUT	plugin-instances/plugins/{pluginInstalledId}/attributes/{name}	Plugin instance attribute save
GET	plugin-instances/plugins/{pluginInstalledId}/attributes/by-names	Plugin instance attribute get all by names

PUT plugin-instances/plugins/{pluginInstalledId}/attributes

Plugin instance attribute save all.

Payload

Request body

[
  {
    "valueDouble": 125.5,
    "settingType": "string",
    "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "name": "Example",
    "valueNumeric": 125.5,
    "valueString": "string"
  }
]

PUT plugin-instances/plugins/{pluginInstalledId}/attributes/{name}

Plugin instance attribute save.

Parameter	In	Required	Type
name	path	yes	string
valueString	query	no	string
valueNumeric	query	no	double

Payload

Response

{
  "valueDouble": 125.5,
  "settingType": "string",
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "name": "Example",
  "valueNumeric": 125.5,
  "valueString": "string"
}

Instances

Method	Path	What it does
GET	plugin-instances/plugins/{pluginInstalledId}/instances/{pluginInstanceId}	Plugin instance get

Plugin instance delete

Method	Path	What it does
DELETE	plugin-instances/plugins/{pluginInstalledId}/plugin-instance-delete	Plugin instance delete

Plugin instance save

Method	Path	What it does
POST	plugin-instances/plugins/{pluginInstalledId}/plugin-instance-save	Plugin instance save

POST plugin-instances/plugins/{pluginInstalledId}/plugin-instance-save

Plugin instance save.

Payload

Request body

{
  "serviceAccessKey": "string",
  "pluginInstanceItem": {
    "instanceAttributes": [
      {
        "valueDouble": 125.5,
        "settingType": "string",
        "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
        "name": "Example",
        "valueNumeric": 125.5,
        "valueString": "string"
      }
    ],
    "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
    "accessHash": "string",
    "dataOwnerID": 42,
    "name": "Example"
  }
}

Response

{
  "instanceAttributes": [
    {
      "valueDouble": 125.5,
      "settingType": "string",
      "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
      "name": "Example",
      "valueNumeric": 125.5,
      "valueString": "string"
    }
  ],
  "pluginInstanceID": "3b7f5c2e-9a41-4d8b-bb0e-7c1a2d3e4f50",
  "accessHash": "string",
  "dataOwnerID": 42,
  "name": "Example"
}

Plugin instances get all

Method	Path	What it does
GET	plugin-instances/plugins/{pluginInstalledId}/plugin-instances-get-all	Plugin instances get all