Login/Register
Installatron Server
API Documentation
⌂

Users

GET /users

List or search Installatron Server's users.

Parameters


API

/users
API endpoint.
GET
Method.

Optional parameters

q
string
Search for this string in the following user fields:
  • email
  • node ID
  • username


default is to show all users

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_api_key
The server's Installatron Server Key is invalid.
invalid_argument_user
User specified is not authorized to access this data.
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
Username of this user.
↳
parent
string
Reseller or admin account that owns this user's account. (ie. the account that created this user) This will be either the main administrative user of the server or a reseller who is in turn owned by the main administrative account of the server.
↳
type
enum
user
for an account with no Installatron administrative access.

reseller
for an account with Installatron administrative access. If the
user
matches the admin= value in /usr/local/installatron/etc/settings.ini then they will be have full administrative access to Installatron, otherwise they will receive reseller administrative access.
↳
suspended
boolean
true
= The account is suspended.
false
= The account is not suspended.
↳
locale
enum
Language this user views Installatron in
(eg.
en
,
nl
).

See: Available Installatron Translations for a full list of languages that Installatron is available in.
↳
email
string
User's email address.
↳
websites[]


↳
path
string
The path or URI to the home directory of this domain (without a trailing directory separator).

Important notes for URI values:
  • The entire URI is AES encrypted in Installatron Server's database.
  • To ensure correct URI syntax the username and password values should be URL-encoded.
  • The host portion of the URI is used to distinguish between web servers. It's considered best practice to use a web server-referencing hostname (eg., server123.host.net) or an IP address for the host portion of the URI. If this is not possible, make sure to include the server argument as documented below.

Supported protocols:
  • The local filesystem (including NFS shares)
  • SSH**
  • FTP
  • FTPS
  • SFTP**

** Both password and public key-based authentication are supported for the SSH and SFTP filesystem protocols; to authenticate by public key, substitute the contents of the key for the password.

Reminder: URI's that contain special characters within the username and password values must be URL-encoded per the specification RFC 3986. For example, a username of
user@installatron.com
should be provided as
user%40installatron.com
.

Examples:
  • /home/USERNAME
  • /var/www/vhosts/DOMAIN
  • c:\inetpub\vhosts\DOMAIN
  • sftp://".urlencode('USER').":".urlencode('PASS')."@SERVER
  • sftp://".urlencode('USER').":".urlencode('PASS')."@SERVER/home
  • ssh://".urlencode('USER').":".urlencode('PASS')."@SERVER
↳
vhosts
associative array
Example 1:
  • 'http://mysite.com' => 'httpdocs',
    'http://www.mysite.com' => 'httpdocs'

Example 2:
  • 'http://mysite.com' => 'public_html',
    'http://www.mysite.com' => 'public_html',
    'https://mysite.com' => 'private_html',
    'https://www.mysite.com' => 'private_html'

Example 3:
  • 'http://mysite.com' => 'public_html/mysite.com',
    'http://www.mysite.com' => 'public_html/mysite.com',
    'https://mysite.com' => 'public_html/mysite.com',
    'https://www.mysite.com' => 'public_html/mysite.com'
↳
databases[]


↳
type
enum
Must be a value of
mysql
at this time.
↳
host
string
Hostname/IP of this database's server.
↳
name
string
Name of this database.
↳
user
string
Name of this database-user.
↳
pass
string
Password for this database-user and database pair.

Note that the database-user should have full privileged access to the database.
↳
gid
int
The filesystem POSIX UID that files and folders will be created as for this website.
↳
uid
int
The filesystem POSIX GID that files and folders will be created as for this website.
↳
label
string
A value that uniquely identifies this website.
↳
language
enum
This website's default language. This is the language text strings and error messages will display in for requests involving this website. For example,
en
for English or
nl
for Dutch. See: Available Installatron Languages.
↳
server
string
The host portion of the path URI is used to distinguish between web servers by default. If the path is not defined, and is instead determined On Demand, then the default will be NULL. If for whatever reason this NULL value doesn't correctly distinguish web servers then give this parameter a unique value for each web server.
↳
suspended
boolean
false
= This website is not suspended.
true
= This website is suspended.
↳
vhost_ip
string
The IP address each domain listed in vhosts should resolve to, enabling Installatron Server to install to vhosts that might not resolve through DNS.

Full Examples

Example: List all Installatron Server user's meta data

Method: curl
Installatron Product: Installatron Server 
curl -X POST https://{SERVER_IP}/users \
    -H 'X-API-KEY: {the key= or key2= value from /usr/local/installatron/etc/settings.ini}' \
    -H 'X-HTTP-Method-Override: GET' \
    -H 'Accept: application/json'
Response: json
{
    
    "total_count": 3,
    "has_more": false,
    "data":[
        {
            "id": "useraccountname",
            "parent": "root",
            "type": "user",
            "suspended": false,
            "locale": "en",
            "email": "address@website.com",
            "websites": [
                {
                    "path": "sftp://exampleftpuser:exampleftppassword@website.com",
                    "label": "website.com",
                    "server": "website.com",
                    "parent": "root",
                    "databases": [
                        {
                            "type": "mysql",
                            "host": "localhost",
                            "user": "useraccountname_mytestdb1",
                            "name": "useraccountname_mytestdb1",
                            "pass": "exampledbpassword1"
                        }
                    ],
                    "vhosts": {
                        "http://website.com": "public_html"
                    }
                },
                {
                    "path": "sftp://exampleftpuser:exampleftppassword@website.com/subdomain",
                    "server": "website.com",
                    "label": "subdomain.website.com",
                    "parent": "root",
                    "databases": [
                        {
                            "type": "mysql",
                            "host": "123.123.123.123:3307",
                            "user": "useraccountname_mytestdb2",
                            "name": "useraccountname_mytestdb2",
                            "pass": "exampledbpassword2"
                        }
                    ],
                    "vhosts": {
                        "http://subdomain.website.com": "public_html/subdomain",
                        "https://subdomain.website.com": "public_html/subdomain"
                    }
                }
            ]
        },
        {
            "id": "useraccountname",
            "parent": "root",
            "type": "user",
            "suspended": false,
            "locale": "en",
            "email": "address@website.com",
            "websites": [
                {
                    "path": "sftp://exampleftpuser:exampleftppassword@website.com",
                    "label": "website.com",
                    "server": "website.com",
                    "parent": "root",
                    "databases": [
                        {
                            "type": "mysql",
                            "host": "localhost",
                            "user": "useraccountname_mytestdb1",
                            "name": "useraccountname_mytestdb1",
                            "pass": "exampledbpassword1"
                        }
                    ],
                    "vhosts": {
                        "http://website.com": "public_html"
                    }
                },
                {
                    "path": "sftp://exampleftpuser:exampleftppassword@website.com/subdomain",
                    "server": "website.com",
                    "label": "subdomain.website.com",
                    "parent": "root",
                    "databases": [
                        {
                            "type": "mysql",
                            "host": "123.123.123.123:3307",
                            "user": "useraccountname_mytestdb2",
                            "name": "useraccountname_mytestdb2",
                            "pass": "exampledbpassword2"
                        }
                    ],
                    "vhosts": {
                        "http://subdomain.website.com": "public_html/subdomain",
                        "https://subdomain.website.com": "public_html/subdomain"
                    }
                }
            ]
        },
        {
            "id": "useraccountname",
            "parent": "root",
            "type": "user",
            "suspended": false,
            "locale": "en",
            "email": "address@website.com",
            "websites": [
                {
                    "path": "sftp://exampleftpuser:exampleftppassword@website.com",
                    "label": "website.com",
                    "server": "website.com",
                    "parent": "root",
                    "databases": [
                        {
                            "type": "mysql",
                            "host": "localhost",
                            "user": "useraccountname_mytestdb1",
                            "name": "useraccountname_mytestdb1",
                            "pass": "exampledbpassword1"
                        }
                    ],
                    "vhosts": {
                        "http://website.com": "public_html"
                    }
                },
                {
                    "path": "sftp://exampleftpuser:exampleftppassword@website.com/subdomain",
                    "server": "website.com",
                    "label": "subdomain.website.com",
                    "parent": "root",
                    "databases": [
                        {
                            "type": "mysql",
                            "host": "123.123.123.123:3307",
                            "user": "useraccountname_mytestdb2",
                            "name": "useraccountname_mytestdb2",
                            "pass": "exampledbpassword2"
                        }
                    ],
                    "vhosts": {
                        "http://subdomain.website.com": "public_html/subdomain",
                        "https://subdomain.website.com": "public_html/subdomain"
                    }
                }
            ]
        }
    ]
}


Since 2004, Installatron has pioneered web application management solutions trusted by businesses and website owners worldwide.
Installatron Plugin Installatron Server Installatron Remote
Resources Developers
Company Support My Account
© 2025 Installatron LLC