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 v2 INTERWORX API KEY-----
MXxnJ3laaidAMm1ndTlIMEBaNVd7cFhYWnxDNUQoRDh6fkdlV3RgbUlEPyEv
BTW01bmRUbElNRUJhTlZkN2NGaFlXbnhETlVRb1JEaDZma2RsVjNSZ2JVbEV
Jy1LQFt7Y3FyLmgiTSRtcSFuXDtIcicwLzl2RzBTRVxPL2JFaXMoZGYyZiJK
IUTFNd0p6UXBQWFJpTENGS2RYZGFaWFoySVZObVVWTWlieXhsUzFwUFdDb21
P0xWRUtLaF02VVkkTz1QLVljJnJyNydZSDZOIUUvXzp9PSx9Sl1gU2k0P1M/
yVlZra1R6MVFMVmxqSm1KeU11ZFpTRFpPSVVVdlh6cDlQU3g1U2wxZ1UyazB
JkSYJWeGJTV3cXaMJzZs1EcKVUVspleRtWQWRVbshFUoRzaRN3dw8kWW12S3
yVjJzRFVVUXRMSFZMVTBwS1JHbHRjM3hBTW10cU9WNWZjRDFXWWs1cVBEdzB
Y2BTXj84e0hkaSxhbSkwUyE2X1pDRW4yOz1IUGdzYEVEcFJ3PldJRTVYWUJP
rYVN4aGJTa3dVeUUyWDFwRFJXNHlPQzVJVUdkQ1lFVkVjRkozUGxkSlJUVll
PiZVKUhgfkNBPzRWN3RAIi1saXBZM31OaX1xVyp3K1o9RisqLjxGOTxBVV9B
zUHpSV04zUkFJaTVzYVhzWk0zNU9hWDV4VnlwM0sxbzlSaXNxTGp4R09UeEJ
MXxnJ3laaidAMm1ndTlIMEBaNVd7cFhYWnxDNUQoRDh6fkdlV3RgbUlEPyEv
x2YUtEcKFzS2tWaYpkUptETS1GVq92VUN3cEFFash1TahWbYtWO1VFVoh0Tk
dDhERl0wJVl+Qjt7PUx3d3hGMHx1Mzw8aiE6JnluZ01SPzRjVlYkLWcyRDdk
rUWp0N1BVeDNkM2hHTUh4MU16dzhhaUU2Sm1sdVowMVNQelJqVmxZa0xXY3l
amBiZzg1bFlQQV42cXwlZG9rR1crRWZzdWsofElKSnBXSDFdQTU/UUdxMHY1
1YHMxdUU/UTQdFDSXBnSKlEfosWdzZWRrc1Rr9GZlwXc24VQQlFb1gzZiBma
Z01rPFV8PW97KmVZO0wsQk4hPXlmTVAkQzZlUEJpNlg2Liw7U2FybXJBckE7
3S21WWk8wd3NRazRoUFhsbVRWQWtRelpsVUVKcE1sZzJMaXc3VTJGeWJYSkJ
Vk14KHF8LkwnbktqdHxKJylAd0xOUlA2OlpjeEluR1FXS2BlWVJ7a2lNW2cv
uYmt0cWRIeEtKeWxBZDB4T1VsQTJPbHBqZUVsdVIxRlhTMkJsV1ZKN2EybE1
IWssQ2IkS3xGbFhcQnFJd141OS1SRmJDaEpwRD1fPUgnLSFbdWZNKnROMH0i
HYkZoY1FuRkpkMTQxT1M1U1JtSkRhRXB3UkQ1ZlBVZ21MU0ZiZFdaTktuUk9
IUTFNd0p6UXBQWFJpTENGS2RYZGFaWFoySVZObVVWTWlieXhsUzFwUFdDb21
1TG1naVRTUnRjU0Z1WER0SWNpY3dMQ2wyUnpzVFJWeFBMMkpGYVhNb1pHWXl
WzoxV1dEQ11USVROez1gMzRncEcnSzM+R0lqTHk9fH4uM1NrW3B0LVc3Yzgm
VU1ZST2V6MWdNelJuY0VjblNDTStSMGxxVEhrOWZINHVNMU1yVzNzMExWYzN
ST1YYm9zSjV1Ql0lMVxoel1RW0lrN28=
-----END v2 INTERWORX API KEY-----',
  'reply_code' => 201,
)

Action: listApikeyVersion

Added in Version

7.13.25-2589

Description

List the version of the installed API Key.

Sample Output

array (
  'status' => 0,
  'payload' => 2,
  'reply_code' => 205,
)

Action: regenerate

Added in Version

7.13.25-2589

Description

Regenerate an API key and return the new one

Action: regenerateNodeApiKey

Added in Version

7.13.25-2589

Description

Regenerate the API key of the node itself, if unclustered.

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

controller

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.