View Plugin
GET
/installs/{id}/plugins/{slug}
View the meta data of a specified WordPress install's plugin.
Parameters
API
/installs/{id}/plugins/{slug}
API endpoint.
{id} is the internal ID of the install to view the plugin of.
{slug} is the internal ID of the plugin to view.
GET
Optional parameters
The system or control panel username the task is to be performed on or for.
default is the owner of the installation identified by {id} in the API request
Response
Response
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.
true
= Success.
false
= Failure.
status code 403
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 system control panel.
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 describing the result of the request. Do not rely on this to determine the success or failure of the request.
↳
The "slug" (aka. internal ID) of the plugin.
(eg.
akismet
,
limit-login-attempts-reloaded
)
↳
State of the plugin.
true
= Plugin is activated.
false
= Plugin is deactivated.
↳
Automatic update configuration for the plugin.
none
= Never update.
all
= All updates will be performed.
↳
Current version of the plugin.
(eg.
5.4.3
)
↳
Full name of the plugin.
(eg.
Akismet Anti-spam: Spam Protection
)
↳
Author's long description of the plugin.
↳
Author's name.
(eg.
Automattic - Anti-spam Team
)
↳
Newest version available of the plugin.
(eg.
5.4.4
)
Full Examples
Example: View the meta data for a single plugin of WordPress install with ID 1234567890abcdefghij12345
Method: curl
$cpapi=https://{USER}:{PASS}@{SERVER_IP}:2083/3rdparty/installatron/index.cgi? # cpanel
#$cpapi=https://{USER}:{PASS}@{SERVER_IP}:2087/3rdparty/installatron/index.cgi? # whm
#$cpapi=https://{USER}:{PASS}@{SERVER_IP}:2222/CMD_PLUGINS/installatron/index.raw? # directadmin
curl -X POST $cpapi/installs/1234567890abcdefghij12345/plugins/akismet \
-H 'X-HTTP-Method-Override: GET' \
-H 'Accept: application/json'
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"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"
}
}
Full Examples
Example: View the meta data for a single plugin of WordPress install with ID 1234567890abcdefghij12345
Method: json payload to curl
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"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"
}
}
Full Examples
Example: View the meta data for a single plugin of WordPress install with ID 1234567890abcdefghij12345
Method: curl, php, and a user's login
<?php
$cpapi = 'https://{USER}:{PASS}@{SERVER_IP}:2083/3rdparty/installatron/index.cgi?'; // cpanel
//$cpapi = 'https://{USER}:{PASS}@{SERVER_IP}:2087/3rdparty/installatron/index.cgi?'; // whm
//$cpapi = 'https://{USER}:{PASS}@{SERVER_IP}:2222/CMD_PLUGINS/installatron/index.raw?'; // directadmin
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_URL => "$cpapi/installs/1234567890abcdefghij12345/plugins/akismet",
CURLOPT_HTTPHEADER => [
"X-HTTP-Method-Override: GET",
"Accept: application/json"
],
CURLOPT_RETURNTRANSFER => true
]);
if (( $response = curl_exec($ch) )=== false )
{
trigger_error(curl_error($ch));
}
curl_close($ch);
var_export(json_decode($response, true));
?>
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"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"
}
}
Full Examples
Example: View the meta data for a single plugin of WordPress install with ID 1234567890abcdefghij12345
Method: cli
/usr/local/installatron/installatron \
--GET /installs/1234567890abcdefghij12345/plugins/akismet
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"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"
}
}
Full Examples
Example: View the meta data for a single plugin of WordPress install with ID 1234567890abcdefghij12345
Method: json payload from cli
Response: json
{
"status": 200,
"result": true,
"message": "The task is complete.\n",
"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"
}
}