Login/Register
Installatron Plugin
API Documentation
⌂

Templates

GET /templates

View the meta data of all administrator/reseller/user Templates.

Parameters


API

/templates
API endpoint.
GET
Method.

Optional parameters

q
string
Search templates for the value of q.
user
string
Change scope to this server or control panel admin, reseller, or user.

default is the current user

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[]


↳
template_scope
enum
Selects which users will have access to the template and in what form the template will be available.
  • user
    - Make this template only accessible to the user that created the template. This template is then available as a content option when this user is installing this type of application in the future. This option is only available to users with websites.
  • admin
    - Make this template available to everyone as a content option for this application.
  • app
    - Make this template available to everyone as a new, separate application in the Applications Browser tab.
↳
template_application
string
Internal application ID of the application this template was created from.
(eg.
wordpress
,
drupal
,
magento
)
↳
template_desc
string
Short description of the template.
(eg.
Adds demo content.
)
↳
template_filename
string
Filename of this Installatron Template archive.
(eg.
template_wordpress_My-Template-Example_2025-01-01_12-01-01
)
↳
template_name
string
Template's title.
(eg.
My Template Example
)
↳
template_time
int
Date and time when the template was created (as a Unix timestamp).
(eg.
1234567890
)
↳
template_appcategory
enum
(When template_scope =
app
)
The category this new application belongs to.
  • _categories_contentmanagementsystems
    = Content Management Systems
  • _categories_communitysoftware
    = Community Software
  • _categories_ecommerceandbusiness
    = eCommerce and Business
  • _categories_imagesandfiles
    = Images and Files
  • _categories_surveysandstatistics
    Surveys and Statistics
  • _categories_miscellaneous
    = Miscellaneous
default is
_categories_contentmanagementsystems
↳
template_apptype
enum
(When template_scope =
app
)
The type of application this is.
  • _types_administration
    = Administration
  • _types_adverts
    = Adverts
  • _types_blog
    = Blog
  • _types_business
    = Business
  • _types_bookmarks
    = Bookmarks
  • _types_calendar
    = Calendar
  • _types_chat
    = Chat
  • _types_clock
    = Clock
  • _types_cms
    = CMS
  • _types_crm
    = CRM
  • _types_ecards
    = eCards
  • _types_ecommerce
    = eCommerce
  • _types_education
    = Education
  • _types_email
    = eMail
  • _types_faqs
    = FAQS
  • _types_files
    = Files
  • _types_forms
    = Forms
  • _types_forum
    = Forum
  • _types_framework
    = Framework
  • _types_gallery
    = Gallery
  • _types_genealogy
    = Genealogy
  • _types_groupware
    = Groupware
  • _types_guestbook
    = Guestbook
  • _types_invoicing
    = Invoicing
  • _types_pollsurvey
    = Poll/Survey
  • _types_portal
    = Portal
  • _types_projects
    = Projects
  • _types_rss
    = RSS
  • _types_search
    = Search
  • _types_statistics
    = Statistics
  • _types_support
    = Support
  • _types_tickets
    = Tickets
  • _types_tool
    = Tool
  • _types_wiki
    = Wiki
  • _types_vpn
    = VPN
  • _types_addon
    = Addon
  • _types_plugin
    = Plugin
  • _types_theme
    = Theme
  • _types_securityrelease
    Security Release
  • _types_majorversion
    = Major Version
  • _types_betarelease
    = Beta Release
  • _types_addendum
    = Addendum
↳
template_linkdocs
string
(When template_scope =
app
)
URL to the documentation for this new application.
(eg.
https://website.com/mynewapplication/docs
)
↳
template_linkfaq
string
(When template_scope =
app
)
URL to the frequently asked questions (FAQ) page for this new application.
(eg.
https://website.com/newapplication/faq
)
↳
template_linksite
string
(When template_scope =
app
)
URL to the website of this new application.
(eg.
https://website.com/newapplication
)
↳
template_linksupport
string
(When template_scope =
app
)
URL to support for this new application.
(eg.
https://website.com/newapplication/forum
)
↳
template_longdesc
string
(When template_scope =
app
)
A longer, detailed description for this application.
↳
id
string
Internal ID for this template.
(eg.
1234567890abcdefghij12345
)
↳
file
string
Path to Installatron's data file for this template.
(eg.
/root/.appdata/templates/1234567890abcdefghij12345
)
↳
agent
string
Version of Installatron that created this template.
(eg.
10.0.0
)
↳
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.
↳
autobk
enum
The automatic backup configuration.
  • none
    = Auto-backups are disabled.
  • schedule
    = Use the admin-defined backup schedule referenced by the autobk_schedule parameter.
  • custom
    = Use the backup schedule defined by the combined autobk_daily, autobk_weekly, and autobk_monthly parameters.


default is
none
↳
autobk_schedule
string
(Only when autobk is
schedule
)
Internal ID of backup schedule that will be used for this app's backing up.
(eg.
1234567890abcdefghij1234567890ab
)

Schedules are created by an admin or reseller account in Installatron administration > Schedules and a schedule ID can be found by either editing the schedule from there (the ID is the first value displayed on the edit page), or by using the GET /set/backup_schedules API.

default is no value
↳
autoup
enum
Automatic update configuration.
  • none
    = Never update.
  • all
    = Always update.
    • minor
    = Update to new minor versions.


default is
minor
↳
autoup_backup
enum
Automatically create a backup and automatically restore the backup if the update fails.
  • none
    = Never backup.
  • all
    = Always backup.


default is
all
↳
autoup_plugins
enum
(WordPress only) Automatic plugin update configuration.
  • none
    = Never update.
  • all
    = Always update.
  • custom
    = Per-plugin control over what will and won't be auto-updated.


default is
all
↳
autoup_themes
enum
(WordPress only) Automatic themes update configuration.
  • none
    = Never update.
  • all
    = Always update.
  • custom
    = Per-theme control over what will and won't be auto-updated.


default is
all
↳
bkloc
string
Location of new backups for this app.
  • local
    for the user's account
  • Or the internal ID of a remote backup location. (eg.
    1234567890abcdefghij12345
    )
↳
cache_files
(internal use only)
↳
cache_numbackups
(internal use only)
↳
cache_preview
(internal use only)
↳
cache_table
(internal use only)
↳
cache_time
(internal use only)
↳
files
array of strings
Array of files and folders that Installatron knows to be associated with this app.

eg.
"tables": [
  "index.php",
  "license.txt",
  ".htaccess",
  ".maintenance",
  "readme.html",
  "wp-activate.php",
  "wp-admin",
  "wp-app.php",
  "wp-blog-header.php",
  "wp-comments-post.php",
  "wp-config.php",
  "wp-config-local.php",
  "wp-config-sample.php",
  "wp-content",
  "wp-cron.php",
  "wp-includes",
  "wp-links-opml.php",
  "wp-load.php",
  "wp-login.php",
  "wp-mail.php",
  "wp-settings.php",
  "wp-signup.php",
  "wp-trackback.php",
  "xmlrpc.php"
],
↳
notification
array of strings
Array of email notifications that the owner of this app will receive. An empty array means no notifications.

Available notifications:
  • backup
  • backup_error
  • clone
  • clone_error
  • install
  • install_error
  • plugin_update
  • plugin_update_available
  • plugin_update_error
  • restore
  • restore_error
  • sync
  • sync_error
  • template
  • template_error
  • update
  • update_available
  • update_error
(eg.
["update_available","update","update_error"]
)
(eg.
[]
for no notifications)

default is all notification types enabled
↳
path
string
Location where this template's files came from.
(eg.
/home/username/public_html/blog
)
(eg.
/var/www/vhosts/mydomain.com
)
(eg.
c:\inetpub\vhosts\mydomain.com
)
↳
tables
array of strings
Array of all database tables Installatron knows to be associated with this app.

eg.
"tables": [
  "wp_commentmeta",
  "wp_comments",
  "wp_links",
  "wp_options",
  "wp_postmeta",
  "wp_posts",
  "wp_term_relationships",
  "wp_term_taxonomy",
  "wp_termmeta",
  "wp_terms",
  "wp_usermeta",
  "wp_users"
],
↳
themes
array structure
(WordPress only) Array of information about the themes used by this application and whether auto-updating is enabled.

eg.
"themes": [
  {
    "id": "twentytwentythree",
    "version": "1.6",
    "active": false,
    "autoup": "all"
  },
  {
    "id": "twentytwentyfive",
    "version": "1.1",
    "active": false,
    "autoup": "all"
  }
],


See the GET /installs/themes API for more information.
↳
time_created
integer
Date and time when this application was installed (as a Unix timestamp).
(eg.
1234567890
)
↳
title
string
Original title of install this template was generated from.
↳
url
string
Original url of install this template was generated from.
↳
user
string
Username of system or control panel username who created this template.
↳
version
string
Application's (as currently used by this website) version.
(eg.
1.2.3
)
↳
vhost
string
Protocol and domain portion of the URL.
(eg. "https://website.com)
↳
email
string
An example custom field value of this installer, in this case the administrative user's email address.
(eg.
username@mydomain.com
)
↳
language
enum
Language used by this install.
(eg.
en
,
no
)

See the GET /browser/{id} API to find a full list of languages supported by this version of this application.
↳
login
string
A custom field value of this installer, in this case the administrative user's username.
(eg.
admin
)
↳
limitloginattempts
boolean
A custom field value of this website, in this case
yes
indicates this optional (WordPress only) plugin is enabled.
↳
sitetitle
string
A custom field value of this website, in this case the website's title.
(eg.
My Family Blog
)
↳
sitetagline
string
A custom field value of this website, in this case the website's tagline.
(eg.
The personal blog of the family Smith.
)
↳
twofactor
boolean
A custom field value of this website, in this case
yes
indicates this optional (WordPress only) plugin is enabled.

Full Examples

Example: View all custom Templates on this 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/templates \
    -H 'X-HTTP-Method-Override: GET' \
    -H 'Accept: application/json'
Response: json
{
    "status": 200,
    "result": true,
    "message": "The task is complete.\n",
    "total_count": 3,
    "has_more": false,
    "data": [
        {
            "template_filename": "template_wordpress_My-example-template_2025-05-04_03-02-00",
            "template_name": "My example template",
            "template_desc": "My example WordPress blog template",
            "template_scope": "admin",
            "template_time": 1234567890,
            "id": "1234567890abcdefghij12345",
            "file": "/root/.appdata/templates/1234567890abcdefghij12345",
            "agent": "10.0.0",
            "application": "wordpress",
            "autoup": "none",
            "autoup_backup": "all",
            "autoup_plugins": "custom",
            "autoup_themes": "none",
            "autobk": "schedule",
            "autobk_schedule": "weeklymonthly",
            "bkloc": "local",
            "cache_archive": 12345678,
            "cache_files": 12345678,
            "cache_preview": 12345,
            "cache_tables": 123456,
            "files": [
                ".htaccess",
                ".maintenance",
                "index.php",
                "it-api.php",
                "license.txt",
                "liesmich.html",
                "readme.html",
                "wp-activate.php",
                "wp-admin",
                "wp-app.php",
                "wp-blog-header.php",
                "wp-comments-post.php",
                "wp-config.php",
                "wp-config-local.php",
                "wp-config-sample.php",
                "wp-content",
                "wp-cron.php",
                "wp-includes",
                "wp-links-opml.php",
                "wp-load.php",
                "wp-login.php",
                "wp-settings.php",
                "wp-signup.php",
                "wp-trackback.php",
                "wp-mail.php",
                "xmlrpc.php"
            ],
            "notification": [
                "backup",
                "backup_error",
                "clone",
                "clone_error",
                "install",
                "install_error",
                "plugin_update",
                "plugin_update_available",
                "plugin_update_error",
                "restore",
                "restore_error",
                "sync",
                "sync_error",
                "template",
                "template_error",
                "update",
                "update_available",
                "update_error"
            ],
            "path": "/home/useraccountname/public_html/blog",
            "plugins": [
                {
                    "id": "akismet",
                    "version": "5.3.6",
                    "activated": false,
                    "autoup": "all"
                },
                {
                    "id": "limit-login-attempts-reloaded",
                    "version": "2.26.18",
                    "activated": true,
                    "autoup": "all"
                }
            ],
            "tables": [
                "wp_commentmeta",
                "wp_comments",
                "wp_links",
                "wp_options",
                "wp_postmeta",
                "wp_posts",
                "wp_term_relationships",
                "wp_term_taxonomy",
                "wp_termmeta",
                "wp_terms",
                "wp_usermeta",
                "wp_users"
            ],
            "themes": [
                {
                    "id": "twentytwentythree",
                    "version": "1.6",
                    "active": false,
                    "autoup": "all"
                },
                {
                    "id": "twentytwentyfive",
                    "version": "1.1",
                    "active": false,
                    "autoup": "all"
                }
            ],
            "time_created": 1234567890,
            "title": "My example blog",
            "url": "https://website.com/blog",
            "user": "useraccountname",
            "version": "6.7.8",
            "vhost": "https://website.com",
            "email": "useraccountname@website.com",
            "language": "en",
            "login": "admin123",
            "limitloginattempts": "yes",
            "sitetitle": "My example blog",
            "sitetagline": "Just another WordPress site",
            "twofactor": "no"
        },
        {
            "template_filename": "template_wordpress_My-example-template_2025-05-04_03-02-00",
            "template_name": "My example template",
            "template_desc": "My example WordPress blog template",
            "template_scope": "admin",
            "template_time": 1234567890,
            "id": "1234567890abcdefghij12345",
            "file": "/root/.appdata/templates/1234567890abcdefghij12345",
            "agent": "10.0.0",
            "application": "wordpress",
            "autoup": "none",
            "autoup_backup": "all",
            "autoup_plugins": "custom",
            "autoup_themes": "none",
            "autobk": "schedule",
            "autobk_schedule": "weeklymonthly",
            "bkloc": "local",
            "cache_archive": 12345678,
            "cache_files": 12345678,
            "cache_preview": 12345,
            "cache_tables": 123456,
            "files": [
                ".htaccess",
                ".maintenance",
                "index.php",
                "it-api.php",
                "license.txt",
                "liesmich.html",
                "readme.html",
                "wp-activate.php",
                "wp-admin",
                "wp-app.php",
                "wp-blog-header.php",
                "wp-comments-post.php",
                "wp-config.php",
                "wp-config-local.php",
                "wp-config-sample.php",
                "wp-content",
                "wp-cron.php",
                "wp-includes",
                "wp-links-opml.php",
                "wp-load.php",
                "wp-login.php",
                "wp-settings.php",
                "wp-signup.php",
                "wp-trackback.php",
                "wp-mail.php",
                "xmlrpc.php"
            ],
            "notification": [
                "backup",
                "backup_error",
                "clone",
                "clone_error",
                "install",
                "install_error",
                "plugin_update",
                "plugin_update_available",
                "plugin_update_error",
                "restore",
                "restore_error",
                "sync",
                "sync_error",
                "template",
                "template_error",
                "update",
                "update_available",
                "update_error"
            ],
            "path": "/home/useraccountname/public_html/blog",
            "plugins": [
                {
                    "id": "akismet",
                    "version": "5.3.6",
                    "activated": false,
                    "autoup": "all"
                },
                {
                    "id": "limit-login-attempts-reloaded",
                    "version": "2.26.18",
                    "activated": true,
                    "autoup": "all"
                }
            ],
            "tables": [
                "wp_commentmeta",
                "wp_comments",
                "wp_links",
                "wp_options",
                "wp_postmeta",
                "wp_posts",
                "wp_term_relationships",
                "wp_term_taxonomy",
                "wp_termmeta",
                "wp_terms",
                "wp_usermeta",
                "wp_users"
            ],
            "themes": [
                {
                    "id": "twentytwentythree",
                    "version": "1.6",
                    "active": false,
                    "autoup": "all"
                },
                {
                    "id": "twentytwentyfive",
                    "version": "1.1",
                    "active": false,
                    "autoup": "all"
                }
            ],
            "time_created": 1234567890,
            "title": "My example blog",
            "url": "https://website.com/blog",
            "user": "useraccountname",
            "version": "6.7.8",
            "vhost": "https://website.com",
            "email": "useraccountname@website.com",
            "language": "en",
            "login": "admin123",
            "limitloginattempts": "yes",
            "sitetitle": "My example blog",
            "sitetagline": "Just another WordPress site",
            "twofactor": "no"
        },
        {
            "template_filename": "template_wordpress_My-example-template_2025-05-04_03-02-00",
            "template_name": "My example template",
            "template_desc": "My example WordPress blog template",
            "template_scope": "admin",
            "template_time": 1234567890,
            "id": "1234567890abcdefghij12345",
            "file": "/root/.appdata/templates/1234567890abcdefghij12345",
            "agent": "10.0.0",
            "application": "wordpress",
            "autoup": "none",
            "autoup_backup": "all",
            "autoup_plugins": "custom",
            "autoup_themes": "none",
            "autobk": "schedule",
            "autobk_schedule": "weeklymonthly",
            "bkloc": "local",
            "cache_archive": 12345678,
            "cache_files": 12345678,
            "cache_preview": 12345,
            "cache_tables": 123456,
            "files": [
                ".htaccess",
                ".maintenance",
                "index.php",
                "it-api.php",
                "license.txt",
                "liesmich.html",
                "readme.html",
                "wp-activate.php",
                "wp-admin",
                "wp-app.php",
                "wp-blog-header.php",
                "wp-comments-post.php",
                "wp-config.php",
                "wp-config-local.php",
                "wp-config-sample.php",
                "wp-content",
                "wp-cron.php",
                "wp-includes",
                "wp-links-opml.php",
                "wp-load.php",
                "wp-login.php",
                "wp-settings.php",
                "wp-signup.php",
                "wp-trackback.php",
                "wp-mail.php",
                "xmlrpc.php"
            ],
            "notification": [
                "backup",
                "backup_error",
                "clone",
                "clone_error",
                "install",
                "install_error",
                "plugin_update",
                "plugin_update_available",
                "plugin_update_error",
                "restore",
                "restore_error",
                "sync",
                "sync_error",
                "template",
                "template_error",
                "update",
                "update_available",
                "update_error"
            ],
            "path": "/home/useraccountname/public_html/blog",
            "plugins": [
                {
                    "id": "akismet",
                    "version": "5.3.6",
                    "activated": false,
                    "autoup": "all"
                },
                {
                    "id": "limit-login-attempts-reloaded",
                    "version": "2.26.18",
                    "activated": true,
                    "autoup": "all"
                }
            ],
            "tables": [
                "wp_commentmeta",
                "wp_comments",
                "wp_links",
                "wp_options",
                "wp_postmeta",
                "wp_posts",
                "wp_term_relationships",
                "wp_term_taxonomy",
                "wp_termmeta",
                "wp_terms",
                "wp_usermeta",
                "wp_users"
            ],
            "themes": [
                {
                    "id": "twentytwentythree",
                    "version": "1.6",
                    "active": false,
                    "autoup": "all"
                },
                {
                    "id": "twentytwentyfive",
                    "version": "1.1",
                    "active": false,
                    "autoup": "all"
                }
            ],
            "time_created": 1234567890,
            "title": "My example blog",
            "url": "https://website.com/blog",
            "user": "useraccountname",
            "version": "6.7.8",
            "vhost": "https://website.com",
            "email": "useraccountname@website.com",
            "language": "en",
            "login": "admin123",
            "limitloginattempts": "yes",
            "sitetitle": "My example blog",
            "sitetagline": "Just another WordPress site",
            "twofactor": "no"
        }
    ]
}


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