Create plugin instance

PUT

/api/v1/plugin-instance

const url = 'https://example.com/api/v1/plugin-instance';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"user":"example","plugin_id":"example","enabled":true,"auth":{"additionalProperty":"example"},"config":{},"state":{},"status":"configured"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/plugin-instance \
  --header 'Content-Type: application/json' \
  --data '{ "user": "example", "plugin_id": "example", "enabled": true, "auth": { "additionalProperty": "example" }, "config": {}, "state": {}, "status": "configured" }'

Creates a plugin instance for the authenticated user.

Request Body^required

application/json

object

user

required

User record ID

string

plugin_id

required

string

enabled

boolean

auth

object

key

additional properties

string

config

object

key

additional properties

any

state

object

key

additional properties

any

status

string

Allowed values: configured needs_auth needs_reauth syncing rate_limited unavailable unsupported_protocol error disabled

Responses

200

Plugin instance created

400

Bad Request

401

Unauthorized

500

Internal Server Error

Create plugin instance

Request Bodyrequired

Responses

200

400

401

500

Request Body^required