Login/Register
Installatron Server
API Documentation
⌂

Edit Plugin

POST /installs/{id}/plugins/{slug}

Edit a plugin's activation and automatic update status for the specified instance of WordPress.

Parameters


API

/installs/{id}/plugins/{slug}
API endpoint.

{id} is the internal ID of the install to edit the plugin of.
{slug} is the internal ID of the plugin to edit.
POST
Method.

Optional parameters

activated
boolean
State of the plugin.
true
= Plugin is activated.
false
= Plugin is deactivated.

default is to not change the current state
autoup
enum
Automatic update configuration for the plugin.
none
= Never update.
all
= All updates will be performed.

default is to not change the current state
user
string
The Installatron Server user the task is to be performed on or for.

default is the owner of the installation identified by {id} in the API request

Special parameters

dryrun
enum
Perform a test run of this API call: run the tests, check connections to the database server and remote locations, but don't actually perform this task itself. This is just a test-run to make sure that when it is run for real that there is nothing to stop it from working.
  • none
    = No dry run.
  • all
    = Check all input values and test all connections.
  • input
    = Check only the input values.


default is
none

Response


Response

status
int
HTTP status code describing the result of the request.

200
for Success.
All other numbers represent errors which are described in the errcode output below.
result
boolean
true
= Success.
false
= Failure.
errcode
string
status code 200
complete_dryrun
dryrun was enabled and finished without error.
status code 403
invalid_api_key
The server's Installatron Server Key is invalid.
invalid_argument_user
User specified is not authorized to access this data.
status code 404
install_not_found
The app ID was not found or it was found by is owned by a user who does not have access to it.
plugin_not_found
The specified plugin was not found on the specified install.
user_not_found
The specified user could not be found in the Installatron Server database.
errfield
enum
If the cause of an error was an incorrect field value then this will show the ID of the field.
(eg.
login
,
passwd
,
email
)
message
string
Message describing the result of the request. Do not rely on this to determine the success or failure of the request.
data


↳
id
string
The "slug" (aka. internal ID) of the plugin.
(eg.
akismet
,
limit-login-attempts-reloaded
)
↳
activated
boolean
State of the plugin.
true
= Plugin is activated.
false
= Plugin is deactivated.
↳
autoup
enum
Automatic update configuration for the plugin.
none
= Never update.
all
= All updates will be performed.
↳
version
string
Current version of the plugin.
(eg.
5.4.3
)
↳
name
string
Full name of the plugin.
(eg.
Akismet Anti-spam: Spam Protection
)
↳
description
string
Author's long description of the plugin.
↳
author
string
Author's name.
(eg.
Automattic - Anti-spam Team
)
↳
version_available
string
Newest version available of the plugin.
(eg.
5.4.4
)

Full Examples

Example: Deactivate a plugin of the WordPress install with ID 1234567890abcdefghij12345

Method: curl
Installatron Product: Installatron Server (switch to Installatron Plugin)
curl -X POST https://{SERVER_IP}/installs/1234567890abcdefghij12345/plugins/limit-login-attempts-reloaded \
    -H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
        {
            "activated": false
        }
       '
Response: json
{
    "status": 200,
    "result": true,
    "message": "The task is complete.\n",
    "errcode": null,
    "errfield": null,
    "data": {
        "id": "limit-login-attempts-reloaded",
        "activated": false,
        "autoup": "none",
        "version": "2.3.4",
        "name": "Limit Login Attempts Reloaded",
        "description": "Block excessive login attempts and protect your site against brute force attacks. Simple, yet powerful tools to improve site performance.",
        "author": "Limit Login Attempts Reloaded",
        "version_available": "2.3.4"
    }
}

Example: Enable automatic-update for a plugin of the WordPress install with ID 1234567890abcdefghij12345

Method: curl
Installatron Product: Installatron Server (switch to Installatron Plugin)
curl -X POST https://{SERVER_IP}/installs/1234567890abcdefghij12345/plugins/akismet \
    -H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
        {
            "autoup": "all"
        }
       '
Response: json
{
    "status": 200,
    "result": true,
    "message": "The task is complete.\n",
    "errcode": null,
    "errfield": null,
    "data": {
        "id": "akismet",
        "activated": true,
        "autoup": "true",
        "version": "5.4.3",
        "name": "Akismet Anti-spam: Spam Protection",
        "description": "Used by millions, Akismet is quite possibly the best way in the world to <strong>protect your blog from spam</strong>. Akismet Anti-spam keeps your site protected even while you sleep. To get started: activate the Akismet plugin and then go to your Akismet Settings page to set up your API key.",
        "author": "Automattic - Anti-spam Team",
        "version_available": "5.4.4"
    }
}


© 2004 - 2025 Installatron LLC. All rights reserved. Privacy Policy.