Chapter 91: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 93: Controller: /siteworx/ssl/key 

92 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
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—--
MIIC0zCCAbsCAQAwgY0xCzAJBgNVBAYTAlVTMQswCQYDVQQIDAJQQTETMBEGA1UE
BwwKUGl0dHNidXJnaDESMBAGA1UECgwJSW50ZXJXb3J4MRAwDgYDVQQLDAdUZXN0
aW5nMRQwEgYDVQQDDAtleGFtcGxlLmNvbTEgMB4GCSqGSIb3DQEJARYRYWRtaW5A
ZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCl6cLz
DzCGfFT4vdizRjah4fzYFRkolKqa+CFKTkWb1vMseFb8OZHR9/qXHo4AygYKuPrL
eod6tm5pqcsUoaMlwMoGUVgOOSiyR4SFxYYjSDIX6BOzZ5mQNkXeRtGEBwgbO0YT
OAPn7YP14ai8WsazMNYyf0orxmNPOWEtJYUKEsd6od/VSWqVjdkpGI3CZboX8HGI
Mzp7cYWkwfITk+p0jYOZgfD5x2/CtpZISNbgb0CPTX+gvtDXOfCE7fHhi4IKRmw9
4aYPfP0KMyFxv19EeKnr0KMHFhZssAEdxPjqeKJ4JmjhEevQ19xvOJvGunbbcat1
ECPzrebQZrPP1t43AgMBAAGgADANBgkqhkiG9w0BAQUFAAOCAQEAHzqjy13Hdh+v
eNwbBFwsjhCEC/722Ys1xaXqRg8KKC8XjU3pjpK9pA/eEr6C1kfZTXqbg7tR3+59
DnwrU4snA28sSH5xZ6rqQvZmC7eKkUbE8lLLJSBafYD0xY7X9wXV19qG3lOZagfx
7ebj+h39w6zmVFjIlM4y+GVueJAHEMVjYqP7NErPnVbFtDEziErxOcL5HLMik0aS
X6vnbURIKkVQ87W3QLL1enjZ7CeqAHGUwC/P0Uouz/ZCoOfeQQSYY5TiOlh3clXS
jQHnKC21tCozoXdeuKecIE2WfCEK2Bv7gidtU1s5nzl9DKsJ9tYHxvoFoRoei4di
dRAQfdx1gQ==
—--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 91: Controller: /siteworx/ssl/crt Up Part III: SiteWorx API Spec Chapter 93: Controller: /siteworx/ssl/key 

(C) 2017 by InterWorx LLC