Part II: NodeWorx API Spec Up Part II: NodeWorx API Spec Chapter 4: Controller: /nodeworx/backup 

3 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—--
MXxfdz1vSjFjZnBfYUkhRVkwMl8+cEFSZS1mLGplIWp2fUZDRD88eDlET20o
qWm1zZllVa2hSVmt3TWw4K2NFRlNaUzVtTEdwbElXcDJmVVpEUkQ4OGVEbEV
LUJ+S21WUmslTXEzT1pLMGJrTy44OzQuVjBRRnFFb2RaMVM9c2pMQkhXSk9F
wWXpjcEpYTkVMVVF6TURWZk1ETm9SRkJrVWswOUsyMTlSU3M2VERKMVpFNHN
V2RRK1k+WGVVOiNwdWxkdz1bJiwqU3o1Olk4XlEkYmFKLiZzdzojbjRjLUhs
WT2lOd2RXeGtkQzFiSml3cVUzbzVPbGs0WGxFa1ltRktMaVp6ZHpvamJqUmp
hGeXJFbzpWY4kFWPpnRTV2a012YrV0VhJGdstUUxonWwlTMQpEdINGMJdkWw
GSkdNbEpUbERWRk11TFRsTmJVNWJlbk16ZDNKclRFc3BXMHBBS1dZM1AxVkh
N110NEcwQ0plK2o+IXBzaThKfVNtMm1eQlh+NEJNPiludT9SK3R0ITZqVjM9
sSzJvK0lYQnphVGhLZlZOdE1tMWVRbGgrTkVKTlBpbHVkVDlTSzNSMElUWnF
REFYMi17Vz0qVWE1VzVNe3V9JSgqWD48Y11eWz9zZW48UndSKj9RUlhoeSNr
xVldFMVZ6Vk1lM1Y1SlNncVdENDhZMTVlV3o1Q1pXNDhVbmRTS2o1UlVsaG9
MXxfdz1vSjFjZnBfYUkhRVkwMl8+cEFSZS1mLGplIWp2fUZDRD88eDlET20o
hFeqtkZWhkTpxGVUh3cYJmczVlUx82VKhXWIZFR1UlTpVzMWp2bxsEeJtmYU
akZob21GXTlTTVc+czllI2F9KldzfWpjRVRNdk82JUkoZjlBZWQqam8jOiN2
UVFZjK2N6bGxJMkY1S2xkQ2ZXcGpSVlJOZGs4MkpVa29aamxzWldRcWFtOGp
SnU0cj1nNzB4eFlULHhpM0pUeGFHRHNqKzNzZzs/Xm42SHZ1e0hKUnA8d0l+
+l0d8AnUKh0e1ZHS24mX/szZzNzKqNHRHFGeUp0MphHLUlFe4BzNn1jc0UnS
ajRDTTgtUkFpZGI0cHtJP19pZz1QKltbaWEkcntkeSFzOXY8ajBlRWxhRlgu
wWkdJMGNIdEpQMTlwWnoxUUtsdGJhV0VrY210a2VTRnpPWFk4YWpzbFJXeGh
RjhxR211SmVIW1tqbmJmZXRPJkZAU2s0YStNKF1FW3NaUHUsbzoyZ1ZxWFBZ
JVzF0cWJtSm1aWFJQSmtaQVUyczBZU3ROS0YxRlczTmFVSFVzYnpveVoxWnh
IWUxQl9wbnV+WW1ZPFQ0W1Ehb18oLnNtXmErcnhkRDUlPXFve0A9V0lXOXoo
rV1c1WlBGUTBXMUVoYjE4b0xuTnRYbUVyY21oa1JEVWxQWEZ2ZTBBOVYwbFh
wWXpjcEpYTkVMVVF6TURWZk1ETm9SRkJrVWswOUsyMTlSU3M2VERKMVpFNHN
sVFhFelQxcExNR0pyVHk0NE9DUXVWakJSUm1GRmIyUmFNVk01YzJwTVFraFh
Wmx+PWpPMX4+Q09bMlFQOEtUUzcjYzc=
—--END INTERWORX API KEY—--’,
)
Action: reroute
Added in version n/a
Description Action to re-route from the current controller to a different one.
Input Parameters
Name Type Notes Required?
controller string Example Values
Index, Overview, Users, Lang, Themes, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Simplescripts, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailPop3, MailSpop3, MailImap, MailSimap, MailSpam, MailVirus, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, ...
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Part II: NodeWorx API Spec Up Part II: NodeWorx API Spec Chapter 4: Controller: /nodeworx/backup 

(C) 2018 by InterWorx LLC