Skip to content
ATTENTION
You are viewing the documentation of the current development state (git-main / nightly).
The current latest stable documentation can be found here.

Admins

Admins.listing

lists all admin entries

Permission

admin

Parameter

FieldTypeDescription
sql_searcharrayoptional array with index = fieldname, and value = array with 'op' => operator (one of <, > or =),LIKE is used if left empty and 'value' => searchvalue
sql_limitintoptional specify number of results to be returned
sql_offsetintoptional specify offset for resultset
sql_orderbyarrayoptional array with index = fieldname and value = ASC|DESC to order the resultset by one or morefields

Response

string as json-encoded array count|list

Admins.listingCount

returns the total number of admins for the given admin

Permission

admin

Response

string as json-encoded response message

Admins.add

create a new admin user

Permission

admin

Parameter

FieldTypeDescription
namestring
emailstring
new_loginnamestring
admin_passwordstringoptional, default auto-generated
def_languagestringoptional, default is system-default language
api_allowedbooloptional, default is true if system setting api.enabled is true, else false
custom_notesstringoptional, default empty
custom_notes_showbooloptional, default false
diskspaceintoptional, default 0
diskspace_ulbooloptional, default false
trafficintoptional, default 0
traffic_ulbooloptional, default false
customersintoptional, default 0
customers_ulbooloptional, default false
domainsintoptional, default 0
domains_ulbooloptional, default false
subdomainsintoptional, default 0
subdomains_ulbooloptional, default false
emailsintoptional, default 0
emails_ulbooloptional, default false
email_accountsintoptional, default 0
email_accounts_ulbooloptional, default false
email_forwardersintoptional, default 0
email_forwarders_ulbooloptional, default false
email_quotaintoptional, default 0
email_quota_ulbooloptional, default false
ftpsintoptional, default 0
ftps_ulbooloptional, default false
mysqlsintoptional, default 0
mysqls_ulbooloptional, default false
customers_see_allbooloptional, default false
caneditphpsettingsbooloptional, default false
change_serversettingsbooloptional, default false
ipaddressarrayoptional, list of ip-address id's; default -1 (all IP's)

Response

string as json-encoded array

Admins.get

return an admin entry by either id or loginname

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the admin-id
loginnamestringoptional, the loginname

Response

string as json-encoded array

Admins.update

update an admin user by given id or loginname

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the admin-id
loginnamestringoptional, the loginname
namestringoptional
emailstringoptional
admin_passwordstringoptional, default auto-generated
def_languagestringoptional, default is system-default language
api_allowedbooloptional, default is true if system setting api.enabled is true, else false
custom_notesstringoptional, default empty
themestringoptional
deactivatedbooloptional, default false
custom_notes_showbooloptional, default false
diskspaceintoptional, default 0
diskspace_ulbooloptional, default false
trafficintoptional, default 0
traffic_ulbooloptional, default false
customersintoptional, default 0
customers_ulbooloptional, default false
domainsintoptional, default 0
domains_ulbooloptional, default false
subdomainsintoptional, default 0
subdomains_ulbooloptional, default false
emailsintoptional, default 0
emails_ulbooloptional, default false
email_accountsintoptional, default 0
email_accounts_ulbooloptional, default false
email_forwardersintoptional, default 0
email_forwarders_ulbooloptional, default false
email_quotaintoptional, default 0
email_quota_ulbooloptional, default false
ftpsintoptional, default 0
ftps_ulbooloptional, default false
mysqlsintoptional, default 0
mysqls_ulbooloptional, default false
customers_see_allbooloptional, default false
caneditphpsettingsbooloptional, default false
change_serversettingsbooloptional, default false
ipaddressarrayoptional, list of ip-address id's; default -1 (all IP's)

Response

string as json-encoded array

Admins.delete

delete a admin entry by either id or loginname

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the admin-id
loginnamestringoptional, the loginname

Response

string as json-encoded array

Admins.unlock

unlock a locked admin by either id or loginname

Permission

admin

Parameter

FieldTypeDescription
idintoptional, the admin-id
loginnamestringoptional, the loginname

Response

string as json-encoded array