Controller: /siteworx/ssl/key¶
- Required Permissions
SSL
- Required Options
SSL Access
Action: delete
¶
- Added in Version
4.7.0-339
- Description
Delete SSL private key.
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 an SSL Key.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
integer |
No* |
2048, 3072, 4096 |
2048 |
* indicates that it’s actually required, but probably already has a valid default value.
Action: getSslKey
¶
- Added in Version
6.0.11-1380
- Description
Get SSL Private Key.
Sample Output¶
array (
'status' => 0,
'payload' => '-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCz1xcJy4gvZBxX
dtaCBt7z38xQHpWtLEG2K97sx+tLzMfAJf2A5iVuFqkVkouEZVT1SRgJ2XWCw19P
KoPUYDv9HP5gWtg9Q0vBhXqg2UHLy6L25gYKP5LKfL7o7HJb88Et0SUCcpimA7fE
VipMzLjkoyg9b8sm1XooEOuZwM/4ehZMJBzPa3s2Pk6WNvkVgqOINjHFQzAQBQfv
z+jXKR3KnixSTJ6FlcdeqVbR3NNVJWwfmokfW0i9zO0FZlcy22ejmgnlrVL3BhHB
vyTA9zLriTTDR0EL/enRRg/jt/waVm1ZWpCHcEY1GyNFmUPDpW0LSStIaBLVngQr
LVVWrVDFAgMBAAECggEACSSyYykZ727jkf7UwR+gTj3eoWQsr/VEEgMA/oDbkasD
rN1BmkAZPxOf3RzqQvzz6NSiiD2qH8/XFKtQsIeEBUZoGHYF8HdvbpNevLbPBZGA
45SmUfcRe4IEIsuCtPIbrDyp6QnygN5HhY/r7qOp8tXowdbhOUQ5Rbg2gkavTC6z
CWMSalERaksx1nlwnyDMpL3icdKd/M/TbHvDxZCzI83R/TPHsysfA1qwhKqt7L8h
G1Z31apkBop0YHXSNGD+XM22JRS7Sbdv/EDQwMdrDTZ0rxq+8HAqHf40WXvaLHdJ
tQlKae36CeAwvLGdiL+nCpWYydfwZqznRj3Wn4CGAQKBgQDZ7lDbaCPg3o/kCgrw
nIB2kM6csxWElALz/IVZXVOFGJ059WeZ0ztqShAUsNazOB+Uqna8Rd3z5wjLCT8h
uJ4zjixCDulaP/q0s0EnVICdqFo0PtRAt49dzAqi0VkKgV6R50igUc/WNpq/sz5M
VgQ1tsKO6SsXxb3/VNVu11/bYQKBgQDTQWO2YwRR3QM6K2u36RJ7NyIwmVGkJwwz
lLK5K25II1UD9JOCKkysfKZ7pdldUJJ0ALJ2LJplq4zl1UL4dWItzJZtlCmqxjN9
9sRKIcVFT1xXEASD7T18fRA4iyIev+LK00LYTFauswlBFWbH6zvQ0d1S9v/1VE7Q
Cx4Op1Hz5QKBgQC5tWpzvaetTRsjASfXaBXUc4uNXtI8WwC1N3/O6kdsyM/afvQc
0jL0XU6cwyECMhY/Uo/B2mvMFxmYIzYIH1G4rzOpyxkxTgnvCD3CLTE4qCjOEqg+
ye1CychafLk6yYl0Hbn23CCW84slRrIUzMvjlezvaWTOajSBK6KBRMkroQKBgHdX
hlv/ne4dO/h9lRHFQmKHJ/JqeruQL41oIHsI9PkdtKZSYY50FPKQTICnlZ7oqION
7UNjOSncevFPw9CWh4s1+3kV7WADLg2n/QWgBFB+X7zzWImq2URdZm968iCK6DUK
mcWVgpaYn867p1+jHRx/old/H+PY59kRnr5KebqdAoGAIT6RnbNfaIwyBzN0QQ6H
wVj1AExTgUAfuQYZ44s1ESBgcDzY9vk/Zd1sGKidSD/x97UUzmTkYPBungXP59yn
hmw8aVIJ4dTvxkt74OnvQhHZouc/48LSR9TcMR47+YgQLYjafJ59XtQBekwoLHRz
C510vhFw32b3oQ+NLmAiAlo=
-----END PRIVATE KEY-----
',
'reply_code' => 205,
)
Action: install
¶
- Added in Version
4.7.0-339
- Description
Install SSL private key.
Input Parameters¶
Name |
Type |
Required? |
Example Values |
Default Values |
Notes |
---|---|---|---|---|---|
|
string |
Yes |
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.