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 |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
No* |
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, … |
US |
Please enter the 2-letter country code corresponding to your country. |
|
string |
Yes |
Please enter the name of the state or province in which you reside. |
||
|
string |
Yes |
Please enter the name of the city in which you reside. |
||
|
string |
Yes |
Please enter the name of the company to which this certificate belongs. |
||
|
string |
Yes |
Please enter the name of the company division to which this certificate belongs. |
||
|
string |
Yes |
example.com, *.com, example.*, *.example.com, ipv4.example.com, mail.example.com, www.example.com, ftp.example.com, sub.example.com |
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. - Common Name |
|
|
struct (string) |
No |
example.com, mail.example.com, www.example.com, ftp.example.com, sub.example.com |
In addition to the primary domain, other domains may be included on the certificate. - Subject Alternative Name |
|
|
string |
Yes |
Please enter the email address that is associated with this certificate. |
* 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
ZXhhbXBsZS5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCz1xcJ
y4gvZBxXdtaCBt7z38xQHpWtLEG2K97sx+tLzMfAJf2A5iVuFqkVkouEZVT1SRgJ
2XWCw19PKoPUYDv9HP5gWtg9Q0vBhXqg2UHLy6L25gYKP5LKfL7o7HJb88Et0SUC
cpimA7fEVipMzLjkoyg9b8sm1XooEOuZwM/4ehZMJBzPa3s2Pk6WNvkVgqOINjHF
QzAQBQfvz+jXKR3KnixSTJ6FlcdeqVbR3NNVJWwfmokfW0i9zO0FZlcy22ejmgnl
rVL3BhHBvyTA9zLriTTDR0EL/enRRg/jt/waVm1ZWpCHcEY1GyNFmUPDpW0LSStI
aBLVngQrLVVWrVDFAgMBAAGgQTA/BgkqhkiG9w0BCQ4xMjAwMAkGA1UdEwQCMAAw
CwYDVR0PBAQDAgXgMBYGA1UdEQQPMA2CC2V4YW1wbGUuY29tMA0GCSqGSIb3DQEB
CwUAA4IBAQBJcvnbaaJ/EoKbW4N4HcTwdJYJ7szpSdbr3ZtGw0KpeqJrVUEKU7y0
JbhYv+aWz+V7BKLolODEYf963qNasVUhbrptwKGl57QvWuN5FIfH0nMiwqrn3qt2
Pc+4Sgf2maSLDMbu05OhEUU9+hJzW99sPKk50Vn2k/+nDA8udosE0EmVchP88Rh+
4G3J+clz4k5iYmvs+P28jYJFk2837uxvNCguWCXebO2W9Y+q0X8RPA9Xx7XBM5+A
SAz0iKfmNkwa5ZFOeat+kYDf+7PrauMFmgePTSA2KLlT/5v9NZMPCR3yZFeySy/0
IMRKRkZ3tW+QuMdLZTDteqxvA1p1gNll
-----END CERTIFICATE REQUEST-----
',
'reply_code' => 205,
)
Action: install
¶
- Added in Version
4.7.0-339
- Description
Install a SSL certificate signing request.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
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.*',
),
'reply_code' => 205,
)
Action: reroute
¶
- Added in Version
n/a
- Description
Action to re-route from the current controller to a different one.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
Index, Overview, Email, EmailBox, EmailAlias, EmailGroup, EmailAutorespond, EmailMailman, DomainsManage, DomainsPointer, DomainsSub, DomainsPhp, Dns, Ssl, SslKey, SslChain, SslCrt, SslCsr, Ftp, FtpSessions, MysqlDb, MysqlUser, MysqlPerms, Cron, Htaccess, Softaculous, Users, Logs, Twofactorauth, EmailRemotesetup, EmailFilters, EmailSpamprefs, EmailSpf, EmailDomainkeys, EmailDmarc, Backup, BackupSchedule, Prefs, Notice, Logout |
Action: win
¶
- Added in Version
n/a
- Description
Magic function - test for testing success mechanism.