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.

Froxlor

Froxlor.checkUpdate

checks whether there is a newer version of froxlor available

Permission

admin

Parameter

FieldTypeDescription
forcebooloptional, force live update-check

Response

string as json-encoded array

Froxlor.importSettings

import settings

Permission

admin

Parameter

FieldTypeDescription
json_strstringcontent of exported froxlor-settings json file

Response

string as json-encoded bool

Froxlor.exportSettings

export settings

Permission

admin

Response

string as json-string

Froxlor.listSettings

return a list of all settings

Permission

admin

Response

string as json-encoded array count|list

Froxlor.getSetting

return a setting by settinggroup.varname couple

Permission

admin

Parameter

FieldTypeDescription
keystringsettinggroup.varname couple

Response

string

Froxlor.updateSetting

updates a setting

Permission

admin

Parameter

FieldTypeDescription
keystringsettinggroup.varname couple
valuestringoptional the new value, default is ''

Response

string

Froxlor.generatePassword

returns a random password based on froxlor settings for min-length, included characters, etc.

Permission

admin customer

Parameter

FieldTypeDescription
lengthintoptional length of password, defaults to 0 (panel.password_min_length)

Response

string

return a one-time login link URL for a given user

Permission

admin

Parameter

FieldTypeDescription
loginnameint $customerid optional, required ifis not specified, user to create link for
customeridstring $loginname optional, required ifis not specified, user to create link for
valid_timeintoptional, value in seconds how long the link will be valid, default is 10 seconds, valid values are numbers from 10 to 120
allowed_fromstringoptional, comma separated list of ip addresses or networks to allow login from via this link

Response

string as json-encoded array [base => domain, uri => relative link]

Froxlor.integrityCheck

can be used to remotely run the integritiy checks froxlor implements

Permission

admin

Response

string

Froxlor.listFunctions

returns a list of all available api functions

Permission

admin customer

Parameter

FieldTypeDescription
modulestringoptional, return list of functions for a specific module
functionstringoptional, return parameter information for a specific module and function

Response

string as json-encoded array