Chapter 93: Controller: /siteworx/ssl/csr Up Part III: SiteWorx API Spec Chapter 95: Controller: /siteworx/twofactorauth 

94 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: 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—--
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDbdAI0oBRZlnAU
CWYIMm2DwvuIQ/eZNoaq1Dg2ikjGuZHqu09zX6hbyqcKpaWdLrvyCQ8K0lDzXlY0
CK5+um6W5f97y1it16jzGa9wkJ65BPgeJSBQk/lMYi5DXn1iyaV19BRzglB+sGnZ
hmrm+92hD8VElixfn2NXAWuiaCwItS3h8BjIi1sCtUglwy42FmH7KU67VzU+D47W
t+FmWZ+viKEdSZopHC38B9FSDfEGgmTkVS19sovkzqnnHkF4ip3Qbtwb1lRiSXTo
+ECvu99v9Zr/IKrJLv7jnsSlqBJVbCucLG0flr3b86URUzMGBVvjnOh36WFZdeRu
SIHHG9wxAgMBAAECggEBALPSvbPtsH8wnKpugSMaX07myUIBn7P2UCdPOrjGW5gr
m3vi/NmnesesqXA6CBlioDNWZPMTH64skSqWKpZBojkYQl9oY0QgQZriYzYz6zvk
7IOXHIGqn0+N7CbcGJaIcYLT/KYiFF+bo0DRumuH2zYNPDJVdArvCnHTAiXUgrCm
cVGa3rXnruMkWECCUV+Qx0xBa+cbLI2jll1BZM3r+MJlRDeulap2D0dCkLsYZIpo
LQsxtqMmip8XlLW/W9dCQBjFE7gra/Krwl8XU+i0ITivlFjtSL7DOGrcpAfdpAeN
kCq1SHNYF1+l/kSoJOPqTo5lXaj8N2wDNWH8HbAZoVkCgYEA9Dl9ew04vFGpGDZc
nKYEJipm0e/neO2EfJ324cl067qJomtLfdliqfGTm3cqcLJj3JOg94Dvo2dci5mu
a4XLRdnmNcUXxQfHzlGeSbXOjAZV3IB2k7LkMz3PYZwD4gbq1QiagtGbn1JZYXO0
BD3mqDad5CsVSsxjHu5dReODWv8CgYEA5gjCn/CgQJOcJ6ywGJqxBRgoOZ1rd0it
TG7QOWIaOWAaG2D8s+EmSDBkD0WsusmwuKzY7XA0QCXzTmosG4P9SimN/v2Ol+e6
E/2sOs07JLrSc3f0RFrQWl9qMn9GTCP5vuDO7Y2BCCI1Vip8cVHkNTsyk7D0xN8S
tScN0M+CuM8CgYBqH6k1FVO4EUwHJ2gq8cEPzJENXNAaritJ82JaTq4t2MsB9tnA
//ttmXnormmUuw/Fw6jIpBB90uZWCxvNwT/JRJxSdSiVB4J9Vt4PbZ8pHX+l53Sf
Tbb3xT4eTispxpO4qpppiieznZcVT6/DwBpAsir+APKppBLWWAHT4r8rhQKBgDZb
D5I3i8Z2msmNNrc5pmarxKWImyI+nCSZcr58ffHc0Y5ypoPiyeb4+EvbjOs+SXH5
9fB1OQOHdCytTeraj3l8xD7ir1UZvpCGurHSWQ1ez+fVCnU0eFNChJeWF4haX+NI
v9zGOR0w6CWKOImWbjRd3p+jitMSWxtPNSaIQj1lAoGBAMODBkn3qXBTREbWlZ4C
F4AOu/lAxe25HZxsUTT6ebsM4vKfbnfxleScznpC/1OEEhpiYNCVKirzE94wOjJ+
UkqWxavXpNrWpq89cly/9ns0OiWZSDttuWqyxBmCVDuK32hAqU3b3jdui4eeBpYf
iEVApDUIi8GriXPS1iWHWnOL
—--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
 Chapter 93: Controller: /siteworx/ssl/csr Up Part III: SiteWorx API Spec Chapter 95: Controller: /siteworx/twofactorauth 

(C) 2017 by InterWorx LLC