Chapter 95: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 97: Controller: /siteworx/ssl/key 

96 Controller: /siteworx/ssl/csr

Required Permissions "SSL"
Required Options SSL Access
Action: delete
Added in version 4.7.0-339
Description Delete a SSL certificate signing request.
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 a SSL certificate signing request.
Input Parameters
Name Type Notes Required?
countryName string Help Entry
Please enter the 2-letter country code corresponding to your country.
Example Values
US, CA, AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, ...
Example Default Value
US
No*
stateOrProvinceName string Help Entry
Please enter the name of the state or province in which you reside.
Yes
localityName string Help Entry
Please enter the name of the city in which you reside.
Yes
organizationName string Help Entry
Please enter the name of the company to which this certificate belongs.
Yes
organizationalUnitName string Help Entry
Please enter the name of the company division to which this certificate belongs.
Yes
commonName string Help Entry
Please select the domain name (common name) this certificate will use. If you do not see your desired domain, you will first need to add it as a pointerdomain or as a subdomain in SiteWorx.<br/><br/>Note that ’www.domain.com’ is <strong>not</strong> the same as ’domain.com’.<br/><br/>A wildcard domain begins with an asterisk, ’*’, and is valid for all subdomains. For example, a Common Name of ’*.domain.com’ would create a CSR that is valid for ’domain.com’, ’sub1.domain.com’, ’sub2.domain.com’, and so on.
Example Values
example.com, *.com, example.*, *.example.com, ipv4.example.com, mail.example.com, ftp.example.com, sub.example.com, www.example.com
Yes
subjectAltName struct (string) Help Entry
List alternative domain names you wish to associate with this certificate.
Example Values
example.com, mail.example.com, ftp.example.com, sub.example.com, www.example.com
No
emailAddress string Help Entry
Please enter the email address that is associated with this certificate.
Yes
* indicates that it’s actually required, but probably already has a valid default value
Action: getSslCsr
Added in version 6.0.11-1380
Description Get SSL CSR.
Sample output
array (
’status’ => 0,
’payload’ => ’—--BEGIN CERTIFICATE REQUEST—--
MIIDFDCCAfwCAQAwgY0xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJQQTETMBEGA1UE
BwwKUGl0dHNidXJnaDESMBAGA1UECgwJSW50ZXJXb3J4MRAwDgYDVQQLDAdUZXN0
aW5nMRQwEgYDVQQDDAtleGFtcGxlLmNvbTEgMB4GCSqGSIb3DQEJARYRYWRtaW5A
ZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDq4Y8c
FWUjTK0dTRP1zI6pYdgpVXMpSJZq0MkDrGHb4K4yq0RAhwuyGcnG45iNMfRCEQdE
PkdFI8uNWhpmW0IaUAplZme4VaAhA8MCBId1dt29uqxCf/Fk9wHUyw2/EWza6gAP
GUPxCR+Ij8qVfvDO/CW6K7u2wy8PJ6RuRVbOotUhHbVL82Hz/QoztSBHw+S4tGpH
jexnniKHiz1OB8OYL5tU5U6BrKLqs7XkJ0vPOIXq4rAoCgiDS6WNKNMPxcxXrTUF
672myXoF49k91jblQUJ5Ih+SLDQgl3OJ930FLTCFFtlzaRXtiKDVcQF7gpy8ysad
95CDsya0oSFAG0ALAgMBAAGgQTA/BgkqhkiG9w0BCQ4xMjAwMAkGA1UdEwQCMAAw
CwYDVR0PBAQDAgXgMBYGA1UdEQQPMA2CC2V4YW1wbGUuY29tMA0GCSqGSIb3DQEB
CwUAA4IBAQDCYEuK4KSMjQISLCR9tiZsBGVgFVactcEeL5OCFmiJ/KkX7gugS1H6
aGlGv2jGLXYxFDPebVyWg+5S9SaMEOtf7xcGXnKDbstZzMGN12XApy0oPqjEWT6N
eDBit3UvhAxPDdX9ajNMESRgIWyKW4gp2gwDzpBRc+rxWaCwWPCH69yLRK9iMONp
h6F/3mPdvb38KXwAfcq1tHuXLKtA0bPTe9y2IzY/+3TxWH/OwSl9s5YkXF+cXlEU
ud6C8Mk1OVOw6TPdA+12WN7KK71lnwABSS5eYXd5kCHAE+fU0FwVCSA9Tn3RABd0
BxsJxpwA0nHng7Fg7i8JigvNxKOWNLbM
—--END CERTIFICATE REQUEST—--
’,
)
Action: install
Added in version 4.7.0-339
Description Install a SSL certificate signing request.
Input Parameters
Name Type Notes Required?
csr string Yes
Action: listSslDomains
Added in version 4.7.0-339
Description List domains on this account on which an SSL certificate can be installed.
Sample output
array (
’status’ => 0,
’payload’ =>
array (
0 => ’example.com’,
1 => ’*.com’,
2 => ’example.*’,
),
)
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 95: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 97: Controller: /siteworx/ssl/key 

(C) 2018 by InterWorx LLC