removePlugin

DELETE

/api/v1/plugins/{pluginId}/installation

const url = 'https://example.com/api/v1/plugins/example/installation';
const options = {method: 'DELETE', headers: {'X-CSRF-Token': 'example'}};

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

curl --request DELETE \
  --url https://example.com/api/v1/plugins/example/installation \
  --header 'X-CSRF-Token: example'

Deletes the installation record. Never deletes plugin data; refuses while plugin-owned resources remain. Idempotent for a plugin that is not installed. An installation row for a plugin this release does not know may also be removed; only the row is deleted.

Parameters

Path Parameters

pluginId

required

string

/^[a-z][a-z0-9_]{0,79}$/

Registry identifier such as noise_meter.

Header Parameters

X-CSRF-Token

required

string

Responses

204

Plugin removed

403

Owner or Administrator and CSRF token required

404

Plugin_not_found

409

Plugin_in_use — remaining resources are listed in error.details

application/json

object

error

required

object

code

required

string

Allowed value: plugin_in_use

message

required

string

details

required

object

pluginId

required

string

resources

required

Array<object>

object

kind

required

string

count

required

integer

>= 1

label

required

string

Example

{
  "error": {
    "code": "plugin_in_use"
  }
}