Chapter 92: Controller: /siteworx/ssl/csr Up Part III: SiteWorx API Spec Chapter 94: Controller: /siteworx/twofactorauth 

93 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—--
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCpSrQpVtGSHpYR
a+ZrQ/eWKvQ7nsY1pR6uaxQs1rdltSFjNyiVpgbJh2756L+ArF6sSB32E8heQMGC
tGVKCJ6DX1DUrXxtGy4zQ1V6TY6zuSAsI3caBfyyTV3ncABbuIuv9RU8YyO1p9m/
STr39QDchWNfvVzyaFeciazdDR7/KBR0KsdLLvZJtNHYDzaPpA12U6B6RHGiJTLH
PMWv6Y07lJFd/xi5HqJIp3nw6QXYOzhWvGbdgiGc+o+udQtJMtkCFt072HnoQC88
7+u6mcdNiyr9iwmELFlNuy74zoY20WO5BCFdaKe0mkq5CVIPbQpd6lFkl9r/EmDv
JZqbd3JzAgMBAAECggEAZsXtPbNxIs3iuMzSY4gthEKrZo5rMiH90FE9PENVry8Z
B8xynPbf4/SOULUVnR4Hk3tshPlZiK6zS5AMdbdp08NHpPV1Nh9sGr7j44219jGK
8IDPS0MbN3t0aI48CXKtirK0o6ZkBWHS9SeV3vYkAbwQqgyhop/poCSMht3yVV+Y
fI+A91Gh4sgDGsGttB+Unt9qH8+meTuhJUXxNRMVSOx1+Ae7yFOT4rnSTJc+xpeR
ppfZwZLTqo+MpbB9Lb2+Znd9qjCM0gjBwl013GdAavvSqQEqQtwrmOPWQBBim/cV
wK6pihseOubXEMoNV0YKw3kifLMgea69VXqbE7wc8QKBgQDbfdRK3mDY8WZkU1u4
7OqAPL345xgxoMP3SY3w21V0o0Z0yfEtl5Hi5O5yihmBRbOUYpHF1q++rIgrEQat
ORx4jCw2JFagMDQKciWhe+v+miIxb4jt/CSWhHZ5xGR2tkQ5hfH0RXoK/xoUtSzD
VXHMXmxGm9ptezJjVsHEwTpLtwKBgQDFc1H1kSsspLJNvX/LK/Z7GkmN/yGN3n3g
QgQVmwo+HtZziviLZjjarrLVGDk2utHq+dT/WJzK6R3c1zR3A5lD03lNlAMPYNaF
Qz/OkJhDEbYgOGSVrqw1fgciy+b8rDrylPLj+wmLYywCpSBz5jcyqeb84wiTBcqB
hnoYSsuHJQKBgGlpCrVSCwzlEhmIdvpevVgM0+dfhJ0A6lwudP6BN48mgsW/3hXZ
PvTKoUFc1VbiFJZkqEFtE0XtMhAMwzoZvXSfTPRLi1avD68clrnw+6twdo9rU0WH
3EJ1JzjfeqgQbL97dnGrlCsHzIy5XeAJfvd5OWLHoqUFj3NpzPEjI04NAoGAevSs
JhqnYx6Qdj66VN/klpYxFb65u2nAwyT4/CdXAoYbj0oMKmqWnv9JF9AE2OMPk57O
F9CrmuP+F6bf4fkYuRb4o+m22h24mLXfBxgd6S4fVwMnB9sFHC6F7RJCnjf2YVeF
xZhvQiCYqHEBu4qx9te8ouASV9O0XmJKp9Pz2A0CgYEAnEta347zQIQcrncKfquA
sgmymILZQZV0YT3B28AXi81L6BTG7RhiL24QaK9kSFqKhHhByoveTXG+RS7zZBjh
+TpeD5xYTFBvojnAmofQx2GcBIvJa9AXg9O7dF1rURa9P3oa7Brom5DUUOkz2THq
vEmf9Suf14bgm3Sw7Nx9Lbo=
—--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 92: Controller: /siteworx/ssl/csr Up Part III: SiteWorx API Spec Chapter 94: Controller: /siteworx/twofactorauth 

(C) 2017 by InterWorx LLC