removePlugin

DELETE

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

const url = 'https://example.com/api/v1/plugins/example/installation';
const options = {method: 'DELETE', headers: {cookie: 'tilecast_session=<tilecast_session>'}};

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 \
  --cookie tilecast_session=<tilecast_session>

Requires the Owner or Administrator role and an authenticated user with the admin scope. Cookie requests also require CSRF. 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.

Authorizations

sessionCookie
userBearer

Parameters

Path Parameters

pluginId

required

string

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

Registry identifier such as countdown_bar.

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Responses

204

Plugin removed, or was not installed

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"
  }
}