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

93 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: 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
ZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDbdAI0
oBRZlnAUCWYIMm2DwvuIQ/eZNoaq1Dg2ikjGuZHqu09zX6hbyqcKpaWdLrvyCQ8K
0lDzXlY0CK5+um6W5f97y1it16jzGa9wkJ65BPgeJSBQk/lMYi5DXn1iyaV19BRz
glB+sGnZhmrm+92hD8VElixfn2NXAWuiaCwItS3h8BjIi1sCtUglwy42FmH7KU67
VzU+D47Wt+FmWZ+viKEdSZopHC38B9FSDfEGgmTkVS19sovkzqnnHkF4ip3Qbtwb
1lRiSXTo+ECvu99v9Zr/IKrJLv7jnsSlqBJVbCucLG0flr3b86URUzMGBVvjnOh3
6WFZdeRuSIHHG9wxAgMBAAGgQTA/BgkqhkiG9w0BCQ4xMjAwMAkGA1UdEwQCMAAw
CwYDVR0PBAQDAgXgMBYGA1UdEQQPMA2CC2V4YW1wbGUuY29tMA0GCSqGSIb3DQEB
CwUAA4IBAQANk5v3h2hoE+ums8+TVzazqW1opuFWcqd/qErcxq3J9FG8Lt+vZaIp
SVdZsNVJZz29JFA+GKUHMUvapaZPMETMTzTn6EprHBR/RsatcWU/RZS2noX4Q2iS
/ZAvi2mi3pT7PWoDvti/wrlu1wmYMw7t/Twvyxw9Ci+2mmhj8dJDg7hbvxfpW2ke
X5YyokapOn29UA0jzBx8gLBZHRgbp0uDOPXuvj8WEAUbW+Mi0/9bUpG5xrK+T/vb
IWVLIKiJz+Ve0TaPI5IiXREzLfl410iohegGLXUEtm9Z9oydYMLUIpwCyykQk2+y
Kvym4VknQSezc0DE89RpntD2nzxlx/6E
—--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.*’,
),
)
 Chapter 92: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 94: Controller: /siteworx/ssl/key 

(C) 2017 by InterWorx LLC