Chapter 90: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 92: Controller: /siteworx/ssl/key 

91 Controller: /siteworx/ssl/csr

Required Permissions "SSL"
Required Options SSL Access
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
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: 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.*’,
),
)
 Chapter 90: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 92: Controller: /siteworx/ssl/key 

(C) 2017 by InterWorx LLC