Update plugin instance

POST

/api/v1/plugin-instance/{id}

const url = 'https://example.com/api/v1/plugin-instance/example';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"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 POST \
  --url https://example.com/api/v1/plugin-instance/example \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "auth": { "additionalProperty": "example" }, "config": {}, "state": {}, "status": "configured" }'

Updates plugin instance settings, auth, state, or status.

Parameters

Path Parameters

required

Plugin instance record ID

string

Request Body^required

application/json

object

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 updated

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

Update plugin instance

Parameters

Path Parameters

Request Body required

Responses

200

400

401

404

500

Request Body^required