Note
You are viewing the documentation for a development version of Interworx (7.11). To see documentation for the current generally available release of Interworx, click here: 7.13.
Controller: /nodeworx/apikey¶
- Required Permissions
APIKEY
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete API Key.
Action: fail
¶
- Added in Version
n/a
- Description
Magic function - test for failure mechanism.
Action: generate
¶
- Added in Version
4.7.0-339
- Description
Generates a new API Key.
Action: listApikey
¶
- Added in Version
4.7.0-339
- Description
List the installed API Key.
Sample Output¶
array (
'status' => 0,
'payload' => '-----BEGIN INTERWORX API KEY-----
MXxSekx6dSNXU2ZUdF1zRzhYcEU6RlZwKmlVLWJHSShIXzpUJHdbNThUUEVz
YVTJaVWRGMXpSemhZY0VVNlJsWndLbWxWTFdKSFNTaElYenBVSkhkYk1UaFV
UXBsOSRzcTM8PzpGXSpJSEolPk99Y1I4c1hDLDk9R1k8Kzx7P0hASSFoKlE9
0V2p3L2JDWTlZMGhHYUVBeWJEb3hmakZmSlRRelJsWkhMVnNxV1VKTE1Ibzt
SjJMcSpVSW1kdSluMkd1X3VjSztsUU9LMFBQcHBfJE8oRUE9LzhOXkMwRjdJ
rZFNsdU1rZDFYM1ZqU0N0c1VVOUxNRkJRY0hzZkpFOG9SVUU1TENoT1hrTXd
FlWHVGb1s2VrBDbKZHdHVlUk1GWRlTMZJlTpB1cSVEZEpkeapFa1JGMVtGVt
tZFY1b1VHRkxSenhKTUdWcVJTMW1VV2hqTjFBc01IRm1MbDErSkQ1T1FqWk1
STAxPHUtSy1nOn1EbzUtd1YybkB2S0I0LWs4KlYlPHpFeVJoKlp+cSFNcFBZ
uT241RWJDVXRkMVl1YmtzMlMwSTBMV3M0S2xZbFBIcEZlVkpvS2xwK2NTRk1
dzxyWV1BckE1OiFdaUMpYjEmPmksTyhjRXlsIXJPM3VLa2FpPik6SGxUJGsu
1T2lGZGFVTXBZakVtUG1rc1R1aGpSWGxzSVhKUE0zVkxhMkZwUGlrNlNHeFV
MXxSekx6dSNXU2ZUdF1zRzhYcEU6RlZwKmlVLWJHSShIXzpUJHdbNThUUEVz
lkTDBFcrtmZ3oFWmZXOxc1bK1WY2sWbLhzZUFWW1c0UwUkRPd3ZGRWTwp2S1
ezc6WTk4elVxLkB1TDV4amM9QSYwM3FDNSRzcTI1N1JhZjhEY3BzenhySVVA
4TGtzMVREVjRhbU01UVNZd00zRkROU1JDY1RJNU4xSmhaamhFWTNzQ2VuaHl
biVjSTFeYjhoMmJ9OHRWZU1KdFB6MVQzQENYX219VHpZVXghZixhNGR1anVt
tVna1RGNhxiZhgXVZpHV912XYNEQzQVM6BFdK1UZWRHO9JmMohjYeFTSjVib
SmlJbjB4Jm1mTkU0byhZZzJDdERsPiNRY19QXmdRUGtvJl0kWk9leGZQNnlr
tVGtVMGJ1aFpaekpEZEVSc1BpTlJZMTlRWG1kUlVHdHZKbDBrV2s1bGVHWlF
TzBdLHZfQH1YR08/WmRXLmgrIUV1a01zKDh4bHh7czNdRzMwOTpRY1FGXy1l
ZUjA4L1dtUlhMbWdySVVWMWEwNUNLRGg0YkhoN2NDTmRSQ013T1RwUlkxRkd
XiRMVWRTUnRBey1EZ1pARGIlX1NdTEU9WmtlTTV7TmEtdUFHcFtKP01zfV8u
zZXkxRVoxcEFSR0lsWDFOZFRFVTlXbXRsVFRWN1RtRXRkVUZIY0Z0S1AwMUN
0V2p3L2JDWTlZMGhHYUVBeWJEb3hmakZmSlRRelJsWkhMVnNxV1VKTE1Ibzt
4UHpwR1hTcEpTRW9sUGs1OVkxSTRjMWhETERrOVIxazhLQ3g3UDBoQVNTRm9
M3RBNHFRQUpqTTRsdGlkcW1TRnUxQHdAVkJLakNeSXc4NU17OEdmSg==
-----END INTERWORX API KEY-----',
'reply_code' => 201,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, … |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.