Plugin Set Active State

Change the active state of a plugin. This operation only applies to supervised plugins. - `active`: starts the supervised plugin process. - `inactive`: stops the supervised plugin process. External plugins cannot be managed with this endpoint and will return a bad request error.

PATCH/plugins/{plugin_instance_id}/active

Change the active state of a plugin.

This operation only applies to supervised plugins.

active: starts the supervised plugin process.
inactive: stops the supervised plugin process.

External plugins cannot be managed with this endpoint and will return a bad request error.

Authorization

storyden-session<token>

In: cookie

Path Parameters

plugin_instance_id*string

Plugin ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

active*PluginActiveState

The state of the plugin, whether it is active, inactive, starting or in an error state. When plugins are added, they are initially inactive and must be activated before being used. When activating, the plugin transitions through the "starting" state while the process starts and connects. An active plugin can be deactivated or if it crashes or encounters an error, it will be set to the "restarting" state and a restart will be attempted. If this succeeds, it will transition back to "active", but if it fails again it will transition to the "error" state.

Response Body

`application/json`

curl -X PATCH "https://example.com/plugins/cc5lnd2s1s4652adtu50/active" \  -H "Content-Type: application/json" \  -d '{    "active": "inactive"  }'

{
  "id": "cc5lnd2s1s4652adtu50",
  "added_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "version": "string",
  "status": {
    "active_state": "inactive",
    "deactivated_at": "2019-08-24T14:15:22Z"
  },
  "manifest": {},
  "connection": {
    "mode": "supervised"
  }
}

Empty

{
  "type": "string",
  "title": "string",
  "detail": "string",
  "trace_id": "string",
  "metadata": {}
}

Plugin Set Active State

Authorization

Path Parameters

Request Body

Response Body

200application/json

400

401

404

defaultapplication/json

`application/json`

`application/json`