Self Help Documentation
< All Topics

tool/installssl

PostedFebruary 25, 2022
UpdatedApril 25, 2023

Description

Installs a free Let’s encrypt or a custom SSL certificate to any domain or sub-domain in a given SPanel user account.

Parameters

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.
domainstringYesThe domain the SSL certificate will be installed to.
customstringNoDefault: false (empty). Set to true if you want to install a custom SSL certificate instead of the free Let’s encrypt SSL certificate.
crtstringNoRequired if ‘custom’ is set to true. The certificate (CRT).
keystringNoRequired if ‘custom’ is set to true. The private key of the new certificate.
castringNoRequired if ‘custom’ is set to true. The CA bundle of the new certificate.

Example

PHP
PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'tool/installssl',
//'custom' => true,
//'crt' => '-----BEGIN CERTIFICATE-----
MIICwzCCAaugAwIBAgIJAKJjAgjqoc3WMA0GCSqGSIb3DQEBBQUAMBQxEjAQBgNV
BAMTCXNwYW5lbC5pbzAeFw0yMjAyMjUxMjE1MTRaFw0zMjAyMjMxMjE1MTRaMBQx
EjAQBgNVBAMTCXNwYW5lbC5pbzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC
ggEBAM/H3GiqGNUfmoWbMrmhWYytzaY0HQUGDLP+t+fPf5fyA4HXnOhMe1NKVpPq
7c3QdrJABoQfdeSZxXLjdrp00YlqOnBBAJ/BGaG0BpM9v99/7juT1Uh4qCA3DcJQ
wrX4xt5QuN0RHFIgjcsPYDdaiNVNLvKbA0AzMzawzKDrQjmBtxzhc2rnZT1fS1Gl
yIIPSzDokrhWt/FWuoAdXEkLji8UXSKeyxX7uQM3Wt4dWAQqzgqYr9AJ5mZ/rvVO
WoH45uor+n00HMCE56xCzMQkgVNB9aO2zatlH79cI++d/9WHoV0u45IppmG0k6dn
BPTGaGBfsnJ+A4a5oDt9e7hs/8kCAwEAAaMYMBYwFAYDVR0RBA0wC4IJc3BhbmVs
LmlvMA0GCSqGSIb3DQEBBQUAA4IBAQAdzVpIcmNf1NgOoqN3MbCvEhLMVN278oeh
sj0joUeQd3BTxYpe5ZveU5TDQFVN0QtJaYqPM32nWnKC6z69gf308AvyMetCb5MS
AKyKqFqWH55zdT03Dn6g/AoESZmRM//Wi+2ZuriVdFQWm8n0JrRp6Q+QGpD3++CV
ivaNUn39PPNXkn0Nt3FxDV/KaEsTRfRh1j/69jzbpqf9a86k7fkUjXx4VHIP27+Y
1t3/WIbZcndlaTIOMt7gzjFU7lmBxcL3EEQRlFovWqEhsv+y2Wcsdo3EmkfM2Kzc
i6xwGvmH4qdH5oXgBm2W9x6WIEDCcnq1yhsYIYQAXUiO15cTff/k
-----END CERTIFICATE-----',
//'key' => '-----BEGIN RSA PRIVATE KEY-----
MIIEpAIBAAKCAQEAz8fcaKoY1R+ahZsyuaFZjK3NpjQdBQYMs/63589/l/IDgdec
6Ex7U0pWk+rtzdB2skAGhB915JnFcuN2unTRiWo6cEEAn8EZobQGkz2/33/uO5PV
SHioIDcNwlDCtfjG3lC43REcUiCNyw9gN1qI1U0u8psDQDMzNrDMoOtCOYG3HOFz
audlPV9LUaXIgg9LMOiSuFa38Va6gB1cSQuOLxRdIp7LFfu5Azda3h1YBCrOCpiv
0AnmZn+u9U5agfjm6iv6fTQcwITnrELMxCSBU0H1o7bNq2Ufv1wj753/1YehXS7j
kimmYbSTp2cE9MZoYF+ycn4DhrmgO317uGz/yQIDAQABAoIBAQDHnrkHqRuQbftz
juZN51D0Uep4WirjL6u2peojgHuSDEYIUZCCsS/ulkXVeGgdSsEugUqBVwRZqs5C
kXv4qNDCl1crj5e847TvYNjMTw/u9qZ3gJDxPlIwGRRT8mkOkMLmxWDFqnGuCW6Q
fuYuaAF8A9ot5HVcEZSLX5JIq50FRvnOenpGZXfUFnJECKaBIdhEHFJ3i4JwovmJ
ATRTxFt+uJ2u/8On+GA9I8IPzQsosiSmbaoY9wB5z/ts19ifUEgOsTDLf+fbeplg
S5ftu1AsxoZuF2Ze5kfGlBX5rafeswJ+nMHWU1irzW4Sr8G5L+nsK+/Spu8Q/JzY
6CaPDTJ9AoGBAOxSs9XiDxLJCPNMRBGj5SM3PrIlOdyZiFGndZrRdVyPzk0jxadO
TvzFpqpWmVwUC3+Z+bi+FylyQlD6prxZPfGZJYCGardqeMumnae3RTWVWiPbZc05
TbUms6mj4SRLKYkEAJM+ukmlI9Ez+/IGp6J1A0NdEiWLojp6GegdPJ/XAoGBAOEU
xQinnNEoPkOmJZ1HL1e0bWlEGb8Yw1yi9VG1Wk5x4sSae/SMOCEMPfTLD8TtfILg
EME4EtQLgcMq2cCVkfsXFNjqb48L4kB3B8k/4LLwA8FalDmhjMJOWcSmSU+pHDPi
UFsF3Ysl4zpzZQGIUOzg19yi7FA/ps0/CGW3xelfAoGAKm5i+bkgCbhs0fpUknJB
9wO5TxUeAXzTnA2cMRMApoDvgqw0leiaiAoY9aac3IqA0gVccA45bGimfZGzlEfV
tmZP9Hat/Iayb6ZX0kA2vfs19xAyhBmQ2UC8q23QQ8r3BzHfxJBTtFthRfO2fesx
+BpYXqT8WB9tHmDD/Agb1XsCgYEAowLP0HzT7gcfUQ87nrS3bOWXd+2CWAwvMSA0
W4Dkbnu8qHbZ3zrOS+D53hhSy2TUEFUGzWk2+at7x0V5fyjUGO2Wg6MGOKt6qQWL
9gz1R6LclWRshXCi6PalvO5Rmgf4DPuTBtkwol5GO0bnmDyJn4UX0QuN6nCu9Wb5
RfHavDECgYBD5FfyCnOoUpRT7k+haQ/CH+H6jKrjykQUtpx1v2O8P+zzc07XzVUU
39+NOQYH+eK2nKytFw5RfDyCJwoIbXojEpNzsmSnYA10FPSCe/mU8yfr9neN4hXB
Hn1IRIEqeLXvKaGQMFIla7HVP4nQmv5N/+ybGd1K+Omk3AcckYz72g==
-----END RSA PRIVATE KEY-----',
//'ca' => '-----BEGIN CERTIFICATE-----
MIIC1DCCAb4CAQAwYTFfMA8GA1UEAwwIdGVzdC5jb20wDQYJKoZIhvcNAQkBEwAw
BwYDVQQLEwAwBwYDVQQKEwAwBwYDVQQJEwAwBwYDVQQHEwAwBwYDVQQIEwAwBwYD
VQQREwAwBwYDVQQGEwAwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCi
XfzmQg26ol7vTIkFtIhXQi3SA3YSZxD2oD9g0hn27ho2jXPqSSUpMEM/KqBnINba
ZLdhgkcoZtCvuXNXga4OnNx2eAtyeQv9JuUssiHSdpvBcALuckUuaL4NAq52q5ZP
YJj7N8zkGfzOAkLDwe2QFzU+besC7vxwHwv19yM5aspnuCIU5ZrZIBQ8db9cdh1k
fRoCcxnMRlngZjRRzZ7f5lJmDA6RD7ngw/leabOZbE4E4QG2ZmYdk2Up9jlUTa2k
SNMQXa3ckD0BhXuo4AQ9mXOLRIkFDf7d2yLbdWI3VX2DzgwUA8fVCLQsWSKVhmxS
tL0xl2yKxBk4RX7fvFr1AgMBAAGgMDAuBgkqhkiG9w0BCQ4xITAfMB0GA1UdDgQW
BBRjSvolSh7H7IF6lab4rws6IZcebDALBgkqhkiG9w0BAQsDggEBAHrJ+QuWVpnA
UimMAyNMQfPQVI5XHqB+aawlPqAmT0rZQHtnJmaBCN4/2Z4KM7w/Kbg4B82mfxdL
p9E12JzqBSkCG09Pbq8bq2H4p/lYpuXIsoT5J0mpVX1VcYRGeyP9UkNLWlGLzJ9g
44zw8mILYyBeBhxza+fLm34T9iKN6KaPlledIAROzZM0v6pAhGjTB8j2qyb0oxNj
kcnWufdwF8xErZOGYSJ45RDOyqb3LsSrnydMRBKgBrFjrAvrNnBrKnMcULgxEAj5
z19Jf2vAS0tDOZB+mfQqHt3UBtAIcDu4uq6cJjHgwBmfPorG4IsHSPhh6WM4gerK
7/4pgsg/gXM=
-----END CERTIFICATE-----
'
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

You can find more information about the Endpoint URL in our API Basics article.

Output

JSON
PHP
1
2
3
4
5
6
{
    "result": "success",
    "message": [
        "The certificate has been installed successfully"
    ]
}
Table of Contents