Remove a plugin

DELETE https://runix.chat/api/v1/armada/plugins/{install_id}

Remove a plugin. Its widgets go, its bot is deactivated (its messages stay), and its process stops. Its settings, secrets and links are kept for a week, so that the removal can be undone; then they are deleted.

Guests and bots cannot use this endpoint.

Changes: New in Zulip 13.0 (feature level ZF-0be29a).

Usage examples

The -u line implements HTTP Basic authentication. See the Authorization header documentation for how to get those credentials for users and bots.

curl -sSX DELETE https://runix.chat/api/v1/armada/plugins/1 \
    -u EMAIL_ADDRESS:API_KEY

Parameters

install_id integer required in path

Example: 1

The ID of the plugin's install.


Response

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}