Chapter 96: Controller: /siteworx/ssl/csr Up Part III: SiteWorx API Spec Chapter 98: Controller: /siteworx/twofactorauth 

97 Controller: /siteworx/ssl/key

Required Permissions "SSL"
Required Options SSL Access
Action: delete
Added in version 4.7.0-339
Description Delete SSL private 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 Generate an SSL Key.
Input Parameters
Name Type Notes Required?
key_length integer Example Values
2048, 3072, 4096
Example Default Value
2048
No*
* indicates that it’s actually required, but probably already has a valid default value
Action: getSslKey
Added in version 6.0.11-1380
Description Get SSL Private Key.
Sample output
array (
’status’ => 0,
’payload’ => ’—--BEGIN PRIVATE KEY—--
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDq4Y8cFWUjTK0d
TRP1zI6pYdgpVXMpSJZq0MkDrGHb4K4yq0RAhwuyGcnG45iNMfRCEQdEPkdFI8uN
WhpmW0IaUAplZme4VaAhA8MCBId1dt29uqxCf/Fk9wHUyw2/EWza6gAPGUPxCR+I
j8qVfvDO/CW6K7u2wy8PJ6RuRVbOotUhHbVL82Hz/QoztSBHw+S4tGpHjexnniKH
iz1OB8OYL5tU5U6BrKLqs7XkJ0vPOIXq4rAoCgiDS6WNKNMPxcxXrTUF672myXoF
49k91jblQUJ5Ih+SLDQgl3OJ930FLTCFFtlzaRXtiKDVcQF7gpy8ysad95CDsya0
oSFAG0ALAgMBAAECggEATdQ364JbZPr/Ufo8ZvJFQ3McgXXDFybqULKmKQVx1733
euqtTwRwp69L4Q+BeSfYXBvwYHiSfSKDTG9S2B/dI4LqLvdj3vzgdpAcigqeKBof
F8NHWTGz91Sx0qUGBQ3tGAz5wAcLME9pl4KuCiNp/+wlRC9BoCnE6iykm7V2Mjm4
CyUgbOcu1c2Ptr1fjLEyTc1TCnNW9xKLLQVlJcXXqeF5i2IHNAm9No086idP1pdE
f9Og7U5KiNhfIQpIUB78imgRhkJXZ3iBTDqDo9rGsFOr++Hr8zg67R8glg55BAiX
qv5CcofxEcsWZii8s+wdDD5s/9NcT6eOINTcWA31YQKBgQD2dPUsmfIEStqzkpNY
8pJijeB/GuMAQX5LdsNM0fzkDX0/d4rtWspJxAq+Ca31F11QkrUyXSXfuaw2iI+c
hal/WfRLRgEyizakhPqTE0AmyIAwWz9erOPQfD6W5MFSMvQXTdnw/nAWL4IL2knu
GQZ0bgKHsISsCla6zMEDk18l5QKBgQDz+drIJBNt0qwa4axWd+/tyPCsOe/kbzIP
8Ej5jEaBnSrwV9FFlulP89iZpYRlgI4TKxjIJMa8rFpaZRs/kJQ0vMip1A13C7sY
N9MQ5sAACxc3wEMje0cvYRTASq/J790y00umeppdgvCPBmKxJ6CAe1lfJ4na3cD6
94rk/BFvLwKBgBVK2Xu2+R/Bz88/1JcUrezx0PlqOz5kaiLe6dSTN8QEHlQDYe9L
rrpcw4jTkUHheOBjLGBjh8giZGx5s96T9abZALAYJjZVrKzeCD/4o8w1+k0zNPBb
A3uZoFatAL63RDtXMIMPmGNyS0v22fhGFTat4m4SpAOxCPkug2Zprwi5AoGBAIjW
/MUApv0UCn/RT633+1RtPb/7hvei/ns+FFATQ4BzPKAtQS085YN4i2YyFb4win9p
zq6DIgy0xsCosM3IM7gYopvOWfcJV1jQBswWAF6F2fHlHkMKY/TJCLCJs2sZ5AEb
zfSEE4ybYn114WjnhvhJNulN7d4aPqEEspyYXNb1AoGBAOmSocB2aWzfZCQBCYG6
eDbYipXn0Rfws7fPYh9mhp+X3aqEoqPcGTnStu5OpibBDxAmcdThKE4/Vwwiy8T1
DN9528rG+YpYwTrh31Bsf2WErVzZvmTE/7YAQFidnGUplpSTYnjEBrpskMOZuxO/
LXg54q7Zenn6IuPrY8+JAgQi
—--END PRIVATE KEY—--
’,
)
Action: install
Added in version 4.7.0-339
Description Install SSL private key.
Input Parameters
Name Type Notes Required?
key string Yes
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, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, DomainsSlave, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Simplescripts, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, Backup, BackupSchedule, Prefs, Notice, Logout
Yes
Action: win
Added in version n/a
Description Magic function - test for testing success mechanism.
 Chapter 96: Controller: /siteworx/ssl/csr Up Part III: SiteWorx API Spec Chapter 98: Controller: /siteworx/twofactorauth 

(C) 2018 by InterWorx LLC