Login/Register
Installatron Plugin
API Documentation
⌂

View Logs

GET /logs

View this server or control panel user's Logs.

Parameters


API

/logs
API endpoint.
GET
Method.

Optional parameters

q
string
Search for this string in the following log fields:
  • url
  • title
  • source_url
  • source_title
  • ext_name
  • theme_name
  • plugin_name
  • backup_schedule
  • backup_location
default is to show all log entries
install
string
Show log entries for the install this with this ID.
(eg.
1234567890abcdefghij12345
)

default is to show log entries for all applications
time_from
integer
Show log entries from this Unix timestamp time.
(eg.
1234567890
)

default is to show log entries from 1 week ago
time_until
integer
Show log entries until this Unix timestamp time.
(eg.
1234567890
)

default is to show log entries until now
filter_severity_notice
boolean
true
|
false
to include/exclude log entries of severity level notice.

default is
true
filter_severity_info
boolean
true
|
false
to include/exclude log entries of severity level info.

default is
true
filter_severity_error
boolean
true
|
false
to include/exclude log entries of severity level error.

default is
true
user
string
Change scope to this server or control panel admin, reseller, or user.

default is the current user

Optional pagination parameters

offset
integer
The offset, from the beginning of the full list of results, to begin showing from.

See total_count in the response to find the total number of results: total_count / limit = page count

default is
0
limit
integer
The maximum number of entries to return.

default is
50

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 403
invalid_argument_user
User specified is not authorized to access this data.
status code 404
user_not_found
The specified user could not be found in the system control panel.
message
string
Message describing the result of the request. Do not rely on this to determine the success or failure of the request.
data[]


↳
cmd
enum
Installatron API that produced the log entry.
  • browser/install
  • browser/import
  • browser/migrate
  • installs/status
  • installs/secure
  • installs/insecure
  • installs/view
  • installs/edit
  • installs/backup
  • installs/template
  • installs/clone
  • installs/sync
  • installs/update
  • installs/update/available
  • installs/detach
  • installs/uninstall
  • backups/view
  • backups/restore
  • backups/restoreto
  • templates/view
  • templates/edit
  • templates/delete
↳
application
string
Type of application this is, referenced by its internal application ID.
(eg.
wordpress
,
drupal
,
magento
)

See Apps Table for a complete list of installer IDs.
↳
backup_location
string
Backup location used by the backup.
(eg
local
for the local account, or the internal ID of a remote backup location)
↳
backup_time
integer
Date and time when the backup was created (as a Unix timestamp).
(eg.
1234567890
)
↳
backup_expiry
integer
Number of days before this backup will automatically expire (and Installatron will delete it).
(eg.
12
)
↳
env_id
string
Internal ID of the environmental requirement that Installatron noticed has changed.
(eg.
php_curl
)
↳
env_name
string
Name of the environmental requirement that Installatron noticed has changed.
(eg.
PHP curl
)
↳
env_value
string
Previous version of this environmental requirement.
(eg.
8.11.1
)
↳
env_new_value
string
New version of this environmental requirement.
(eg.
8.12.0
)
↳
install
string
Internal ID of install this log entry is for (for actions like update and backup).
(eg.
1234567890abcdefghij12345
)
↳
is_alarmed
boolean
true
if the user was notified, via email, about about this log event.

Note that there can be a delay between the event happening and the notification being sent.
↳
severity
enum
Type of log entry.
  • notice
    = A task has completed.
  • info
    = Installatron has noticed a change, like a new has become available or the environment has changed.
  • error
    = A serious problem. Address this ASAP.
↳
source
string
Internal ID of install this log entry is for (for actions like clone).
(eg.
1234567890abcdefghij12345
)
↳
source_url
string
Address where this website is viewed online.
(eg.
https://website.com/blog
)
↳
source_title
string
Title of the website, used in Installatron only.
(eg.
My blog
)
↳
theme_id
string
(WordPress only) Theme's internal ID.
(eg.
twentytwentyfive
)
↳
theme_name
string
(WordPress only) Full theme name.
(eg.
Twenty Twenty-Five
)
↳
theme_version
string
(WordPress only) Current version of theme that is installed.
(eg.
1.1.1
)
↳
theme_new_version
string
(WordPress only) New version of theme that is available.
(eg.
1.1.2
)
↳
time_start
integer
Date and time when the task began (as a Unix timestamp).
(eg.
1234567890
)

Tip: time_end - time_start is the time the task took.
↳
time_end
integer
Date and time when the task completed (as a Unix timestamp).
(eg.
1234567890
)
↳
title
string
Title of the website, used in Installatron only.
(eg.
My blog
)
↳
trigger
enum
Installatron sub-system that initiated the task that produced this log entry.
  • autobk
    = The event was triggered by Automatic Backup
  • autoup
    = The event was triggered by Automatic Update
  • external
    = The event was observed (Installatron didn't trigger it)
  • ui
    = The event was triggered from the UI
  • api
    = The event was triggered from the API/CLI
↳
trigger_user
string
Control panel user that owns this install.
(eg.
useraccountname
)
↳
url
string
Address where this website is viewed online.
(eg.
https://website.com/blog
)
↳
user
string
Control panel user that owns this install.
(eg.
useraccountname
)
↳
version
string
Website application's current version.
(eg.
1.1.1
)
↳
security_id
string
The internal ID of the security issue.
↳
security_name
string
The name of the security issue.
↳
security_risk
enum
An Installatron-assigned risk value for the security issue. Values of
low
,
medium
, and
high
.
↳
security_url
string
External URL to more information about the security issue.
↳
new_version
string
New version of the website's application that is available.
(eg.
1.1.2
,
null
)

Full Examples

Example: View all log entries on the server

Method: curl
Installatron Product: Installatron Plugin (switch to Installatron Server)
$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/logs \
    -H 'X-HTTP-Method-Override: GET' \
    -H 'Accept: application/json'
Response: json
{
    
    "total_count": 5,
    "has_more": false,
    "data":[
        {
            "id": 1111,
            "time_start": 1739505674,
            "time_end": 1739505662,
            "cmd": "backup",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "backup": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "source": "1234567890abcdefghiparent",
            "source_user": "useraccountname",
            "source_url": "http://website.com/blog",
            "source_title": "My example blog",
            "backup_location": "local",
            "backup_time": 1739505662,
            "backup_expiry": 12
        },
        {
            "id": 1112,
            "time_start": 1739505677,
            "time_end": 1739505676,
            "cmd": "update",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "new_version": null,
            "url": "http://website.com/blog",
            "title": "My example blog",
            "theme_id": "twentytwentyfive",
            "theme_name": "Twenty Twenty-Five",
            "theme_version": "1.0",
            "theme_new_version": "1.1"
        },
        {
            "id": 1113,
            "time_start": 1739332796,
            "time_end": 1739507520,
            "cmd": "update_available",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.1",
            "new_version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog"
        },
        {
            "id": 1114,
            "time_start": 1739507520,
            "time_end": 1739507520,
            "cmd": "change",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "phpmyfaq",
            "version": "4.0.5",
            "url": "http://website.com/faq",
            "title": "My example site",
            "env_id": "php_curl",
            "env_name": "PHP curl",
            "env_value": "8.11.1",
            "env_new_value": "8.12.0"
        },
        {
            "id": 1115,
            "time_start": 1746207238,
            "time_end": 1746207238,
            "cmd": "vulnerable",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "security_id": "1234ABCD",
            "security_risk": "medium",
            "security_name": "Authenticated (Subscriber+) Directory Traversal",
            "security_url": "https://www.wordfence.com/threat-intel/vulnerabilities/id/1234f123-12f1-1234-01ab-123456abcdef?source=api-prod",
            "plugin_id": "examplewordpressplugin",
            "plugin_name": "ExamplePlugin",
            "plugin_version": "1.2.3",
            "plugin_new_version": null
        }
    ]
}

Example: View a single user's log entries

Method: curl
Installatron Product: Installatron Plugin (switch to Installatron Server)
$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/logs \
    -H 'X-HTTP-Method-Override: GET' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
        {
            "user": "useraccountname"
        }
       '
Response: json
{
    
    "total_count": 5,
    "has_more": false,
    "data":[
        {
            "id": 1111,
            "time_start": 1739505674,
            "time_end": 1739505662,
            "cmd": "backup",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "backup": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "source": "1234567890abcdefghiparent",
            "source_user": "useraccountname",
            "source_url": "http://website.com/blog",
            "source_title": "My example blog",
            "backup_location": "local",
            "backup_time": 1739505662,
            "backup_expiry": 12
        },
        {
            "id": 1112,
            "time_start": 1739505677,
            "time_end": 1739505676,
            "cmd": "update",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "new_version": null,
            "url": "http://website.com/blog",
            "title": "My example blog",
            "theme_id": "twentytwentyfive",
            "theme_name": "Twenty Twenty-Five",
            "theme_version": "1.0",
            "theme_new_version": "1.1"
        },
        {
            "id": 1113,
            "time_start": 1739332796,
            "time_end": 1739507520,
            "cmd": "update_available",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.1",
            "new_version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog"
        },
        {
            "id": 1114,
            "time_start": 1739507520,
            "time_end": 1739507520,
            "cmd": "change",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "phpmyfaq",
            "version": "4.0.5",
            "url": "http://website.com/faq",
            "title": "My example site",
            "env_id": "php_curl",
            "env_name": "PHP curl",
            "env_value": "8.11.1",
            "env_new_value": "8.12.0"
        },
        {
            "id": 1115,
            "time_start": 1746207238,
            "time_end": 1746207238,
            "cmd": "vulnerable",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "security_id": "1234ABCD",
            "security_risk": "medium",
            "security_name": "Authenticated (Subscriber+) Directory Traversal",
            "security_url": "https://www.wordfence.com/threat-intel/vulnerabilities/id/1234f123-12f1-1234-01ab-123456abcdef?source=api-prod",
            "plugin_id": "examplewordpressplugin",
            "plugin_name": "ExamplePlugin",
            "plugin_version": "1.2.3",
            "plugin_new_version": null
        }
    ]
}

Example: View a single app's log entries

Method: curl
Installatron Product: Installatron Plugin (switch to Installatron Server)
$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/logs \
    -H 'X-HTTP-Method-Override: GET' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
        {
            "user": "useraccountname",
            "id": "1234567890abcdefghij12345"
        }
       '
Response: json
{
    
    "total_count": 5,
    "has_more": false,
    "data":[
        {
            "id": 1111,
            "time_start": 1739505674,
            "time_end": 1739505662,
            "cmd": "backup",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "backup": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "source": "1234567890abcdefghiparent",
            "source_user": "useraccountname",
            "source_url": "http://website.com/blog",
            "source_title": "My example blog",
            "backup_location": "local",
            "backup_time": 1739505662,
            "backup_expiry": 12
        },
        {
            "id": 1112,
            "time_start": 1739505677,
            "time_end": 1739505676,
            "cmd": "update",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "new_version": null,
            "url": "http://website.com/blog",
            "title": "My example blog",
            "theme_id": "twentytwentyfive",
            "theme_name": "Twenty Twenty-Five",
            "theme_version": "1.0",
            "theme_new_version": "1.1"
        },
        {
            "id": 1113,
            "time_start": 1739332796,
            "time_end": 1739507520,
            "cmd": "update_available",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.1",
            "new_version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog"
        },
        {
            "id": 1114,
            "time_start": 1739507520,
            "time_end": 1739507520,
            "cmd": "change",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "phpmyfaq",
            "version": "4.0.5",
            "url": "http://website.com/faq",
            "title": "My example site",
            "env_id": "php_curl",
            "env_name": "PHP curl",
            "env_value": "8.11.1",
            "env_new_value": "8.12.0"
        },
        {
            "id": 1115,
            "time_start": 1746207238,
            "time_end": 1746207238,
            "cmd": "vulnerable",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "security_id": "1234ABCD",
            "security_risk": "medium",
            "security_name": "Authenticated (Subscriber+) Directory Traversal",
            "security_url": "https://www.wordfence.com/threat-intel/vulnerabilities/id/1234f123-12f1-1234-01ab-123456abcdef?source=api-prod",
            "plugin_id": "examplewordpressplugin",
            "plugin_name": "ExamplePlugin",
            "plugin_version": "1.2.3",
            "plugin_new_version": null
        }
    ]
}

Example: Search all log entries on the server

Method: curl
Installatron Product: Installatron Plugin (switch to Installatron Server)
$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/logs \
    -H 'X-HTTP-Method-Override: GET' \
    -H 'Accept: application/json' \
    -H 'Content-Type: application/json' \
    -d '
        {
            "q": "family"
        }
       '
Response: json
{
    
    "total_count": 5,
    "has_more": false,
    "data":[
        {
            "id": 1111,
            "time_start": 1739505674,
            "time_end": 1739505662,
            "cmd": "backup",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "backup": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "source": "1234567890abcdefghiparent",
            "source_user": "useraccountname",
            "source_url": "http://website.com/blog",
            "source_title": "My example blog",
            "backup_location": "local",
            "backup_time": 1739505662,
            "backup_expiry": 12
        },
        {
            "id": 1112,
            "time_start": 1739505677,
            "time_end": 1739505676,
            "cmd": "update",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "autoup",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "new_version": null,
            "url": "http://website.com/blog",
            "title": "My example blog",
            "theme_id": "twentytwentyfive",
            "theme_name": "Twenty Twenty-Five",
            "theme_version": "1.0",
            "theme_new_version": "1.1"
        },
        {
            "id": 1113,
            "time_start": 1739332796,
            "time_end": 1739507520,
            "cmd": "update_available",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.1",
            "new_version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog"
        },
        {
            "id": 1114,
            "time_start": 1739507520,
            "time_end": 1739507520,
            "cmd": "change",
            "severity": "notice",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "phpmyfaq",
            "version": "4.0.5",
            "url": "http://website.com/faq",
            "title": "My example site",
            "env_id": "php_curl",
            "env_name": "PHP curl",
            "env_value": "8.11.1",
            "env_new_value": "8.12.0"
        },
        {
            "id": 1115,
            "time_start": 1746207238,
            "time_end": 1746207238,
            "cmd": "vulnerable",
            "severity": "info",
            "is_alarmed": true,
            "trigger": "external",
            "trigger_user": "useraccountname",
            "user": "useraccountname",
            "install": "1234567890abcdefghij12345",
            "application": "wordpress",
            "version": "6.7.2",
            "url": "http://website.com/blog",
            "title": "My example blog",
            "security_id": "1234ABCD",
            "security_risk": "medium",
            "security_name": "Authenticated (Subscriber+) Directory Traversal",
            "security_url": "https://www.wordfence.com/threat-intel/vulnerabilities/id/1234f123-12f1-1234-01ab-123456abcdef?source=api-prod",
            "plugin_id": "examplewordpressplugin",
            "plugin_name": "ExamplePlugin",
            "plugin_version": "1.2.3",
            "plugin_new_version": null
        }
    ]
}


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