Child pages
  • WHM API 1 Functions - fetch_ssl_certificates_for_fqdns
Skip to end of metadata
Go to start of metadata

Description


This function retrieves the certificate information for all fully qualified domain names (FQDNs) that the account owns.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/fetch_ssl_certificates_for_fqdns?api.version=1&domains=example.com%2Cexample2.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/fetch_ssl_certificates_for_fqdns?api.version=1&domains=example.com%2Cexample2.com
 Command Line
whmapi1 fetch_ssl_certificates_for_fqdns domains=example.com,example2.com


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data":{  
    "payload":[  
      {  
        "verify_error":"DEPTH_ZERO_SELF_SIGNED_CERT",
        "subject.commonName":"example.com",
        "domains":[  
          "example.servername.com",
		  "example.com",
          "mail.example.com",
          "www.example.com",
          "www.example.servername.com"
        ],
        "is_self_signed":0,
        "created":1496942050,
        "users":[  
           "example"
        ],
        "validation_type":"dv",
        "issuer.organizationName":"Organization",
        "friendly_name":"example.com and www.example.com",
        "issuer.commonName":"example.servername.com",
        "signature_algorithm":"sha256WithRSAEncryption",
        "not_before":1496950286,
        "modulus_length":2048,
        "not_after":1528486286,
        "cab":"-----BEGIN CERTIFICATE-----
MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD
VQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv
b3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV
UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU
cnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv
RLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M
ypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5
1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz
dcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl
IjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy
bW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY
-----END CERTIFICATE-----", 			
        "id":"example_servername_com_ce52d_6e643_2813308004_1195
80f9b01960cjones72bc519206bc",
        "key":"-----BEGIN RSA PRIVATE KEY-----
MIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65
/tiZe7H0soDp1C55SCG3aGh9s00bGwWaske34/43RR19rmerKGxfN7N5Vu97pfTw
W1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1B
SgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZs
lR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mf
ohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6
uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug
/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopN
KxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39Rn
VkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP
2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEA
AQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87
nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBsc
VBavViREXZdUicGBuX23432l3YXWk75cDZSggevc7Aasdfe30jRd3o0w8aXDoSlE
fYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALr
cdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+
aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2t
WvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMy
Rel+cnqMdiH7r2p6RmgF5c9myDasdeetgbsVrOy8uhw7EMQvT8+YSKaIbgtFZcUS
U02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5
MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZ
LTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i
1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUw
VlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqo
uL9V3vCWYPJSLtCexECGae389vndskwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF
1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY
1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQ
OVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n
0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kp
Ydn1T0vCCHA3bVpaHuqliCoDSXasdfasdfee2CGBbAkmU8RuxDd9yR9l7O9MXUmL
sqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZU
oZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnreh
HCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+Ar
hnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llg
Tr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4T
zIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0
esyzGbT1d/c2rJHMwV1FMvzXkk/asdfew4228FXMTRt4tXHtU8rl93JVq8+aY/Yi
JZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98
e1I5BBNc8G0AYONtSasd3209v09s4kQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOt
PIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNI
fBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq
5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8asd34gOL/Prein5c/LaKJV+8kEUzpTS1
xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5H
zxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPG
sYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fV
BvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWb
mhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30w
yZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==
-----END RSA PRIVATE KEY-----",
        "crt":"-----BEGIN CERTIFICATE----- 
MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ 
c2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI 
DAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy 
MjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV 
BAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G 
CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P 
Xx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW 
voK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da 
M3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC 
+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6 
PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj 
UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw 
+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA 
A4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh 
cDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw 
FYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh 
/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag 
qz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa 
Km6r7YmwfLN/YMZBHXSR58oOGP9W 
-----END CERTIFICATE-----",
		"modulus":"ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3
afd876017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d91
26a4779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e
5b20ad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d
3814ff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c
357e1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f
24fe27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f4082
9faf644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef120
0407eab7c3b71c6e643"
      },
      {  
        "verify_error":"DEPTH_ZERO_SELF_SIGNED_CERT",
        "subject.commonName":"example2.com",
        "domains":[  
          "example2.servername.com",
		  "example2.com",
          "mail.example2.com",
          "www.example2.com",
          "www.example2.servername.com"
        ],
        "is_self_signed":0,
        "created":1496942050,
        "users":[  
           "example2"
        ],
        "validation_type":"dv",
        "issuer.organizationName":"Organization",
        "friendly_name":"example2.com and www.example2.com",
        "issuer.commonName":"example2.servername.com",
        "signature_algorithm":"sha256WithRSAEncryption",
        "not_before":1496950286,
        "modulus_length":2048,
        "not_after":1528486286,
        "cab":"-----BEGIN CERTIFICATE-----
MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD
VQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv
b3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV
UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU
cnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv
RLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M
ypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5
1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz
dcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl
IjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy
bW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY
-----END CERTIFICATE-----", 			
        "id":"example2_servername_com_ce52d_6e643_2813308004_119
580f9b01960cjones72bc519206bc",
        "key":"-----BEGIN RSA PRIVATE KEY-----
MIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65
/tiZe7H0soDp1C55SCG3aGh9s00bGwWaske34/43RR19rmerKGxfN7N5Vu97pfTw
W1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1B
SgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZs
lR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mf
ohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6
uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug
/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopN
KxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39Rn
VkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP
2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEA
AQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87
nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBsc
VBavViREXZdUicGBuX23432l3YXWk75cDZSggevc7Aasdfe30jRd3o0w8aXDoSlE
fYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALr
cdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+
aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2t
WvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMy
Rel+cnqMdiH7r2p6RmgF5c9myDasdeetgbsVrOy8uhw7EMQvT8+YSKaIbgtFZcUS
U02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5
MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZ
LTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i
1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUw
VlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqo
uL9V3vCWYPJSLtCexECGae389vndskwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF
1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY
1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQ
OVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n
0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kp
Ydn1T0vCCHA3bVpaHuqliCoDSXasdfasdfee2CGBbAkmU8RuxDd9yR9l7O9MXUmL
sqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZU
oZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnreh
HCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+Ar
hnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llg
Tr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4T
zIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0
esyzGbT1d/c2rJHMwV1FMvzXkk/asdfew4228FXMTRt4tXHtU8rl93JVq8+aY/Yi
JZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98
e1I5BBNc8G0AYONtSasd3209v09s4kQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOt
PIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNI
fBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq
5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8asd34gOL/Prein5c/LaKJV+8kEUzpTS1
xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5H
zxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPG
sYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fV
BvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWb
mhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30w
yZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==
-----END RSA PRIVATE KEY-----",
        "crt":"-----BEGIN CERTIFICATE----- 
MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ 
c2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI 
DAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy 
MjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV 
BAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G 
CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P 
Xx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW 
voK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da 
M3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC 
+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6 
PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj 
UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw 
+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA 
A4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh 
DDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw 
FYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh 
/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag 
qz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa 
Km6r7YmwfLN/YMZBHXSR58oOGP9W 
 -----END CERTIFICATE-----",
		"modulus":"ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3
afd876017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d91
26a4779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e
5b20ad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d
3814ff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c
357e1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f
24fe27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f4082
9faf644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef120
0407eab7c3b71c6e643"
      }
    ]
  },
   "metadata":{  
      "command":"fetch_ssl_certificates_for_fqdns",
      "version":1,
      "reason":"OK",
      "result":1
   }
}
 Output (XML)
<data>
	<payload>
		<verify_error>DEPTH_ZERO_SELF_SIGNED_CERT</verify_error>
		<subject.commonName>example.com</subject.commonName>
		<domains>example.servername.com</domains>
		<domains>example.com</domains>
		<domains>mail.example.com</domains>
		<domains>www.example.com</domains>
		<domains>www.example.servername.com</domains>
		<is_self_signed>0</is_self_signed>
		<created>1496942050</created>
		<users>example</users>
		<validation_type>dv</validation_type>
		<issuer.organizationName>Organization</issuer.organizationName>
		<friendly_name>example.com and www.example.com</friendly_name>
		<issuer.commonName>example.servername.com</issuer.commonName>
		<signature_algorithm>sha256WithRSAEncryption</signature_algorithm>
		<not_before>1496950286</not_before>
		<modulus_length>2048</modulus_length>
		<not_after>1528486286</not_after>
		<cab>c</cab>
		<id>example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc</id>
		<key>-k</key>
		<crt>c</crt>
		<modulus>m</modulus>
	</payload>
	<payload>
		<verify_error>DEPTH_ZERO_SELF_SIGNED_CERT</verify_error>
		<subject.commonName>example2.com</subject.commonName>
		<domains>example2.servername.com</domains>
		<domains>example2.com</domains>
		<domains>mail.example2.com</domains>
		<domains>www.example2.com</domains>
		<domains>www.example2.servername.com</domains>
		<is_self_signed>0</is_self_signed>
		<created>1496942050</created>
		<users>example2</users>
		<validation_type>dv</validation_type>
		<issuer.organizationName>Organization</issuer.organizationName>
		<friendly_name>example2.com and www.example2.com</friendly_name>
		<issuer.commonName>example2.servername.com</issuer.commonName>
		<signature_algorithm>sha256WithRSAEncryption</signature_algorithm>
		<not_before>1496950286</not_before>
		<modulus_length>2048</modulus_length>
		<not_after>1528486286</not_after>
		<cab>c-</cab>
		<id>example2_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc</id>
		<key>k</key>
		<crt>c</crt>
		<modulus>m</modulus>
	</payload>
</data>
<metadata>
   <version>1</version>
   <reason>OK</reason>
   <result>1</result>
   <command>fetch_ssl_certificates_for_fqdns</command>
</metadata>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

The domain for which to retrieve information.

A valid domain that the account owns.

Notes:

  • Separate multiple domains with a comma character (,).
  • For browser-based calls, use a URI encoded comma (%2C).

example.com,example2.com

 

Returns

ReturnTypeDescriptionPossible valuesExample

payload

hash

A hash of the certificate information.

This hash includes the verify_error, subject.commonName, is_self_signed, created, validation_type, issuer.organizationName, friendly_name, issuer.commonName, signature_algorithm, not_before, modulus_length, not_after, cab, id, key, crt, and modulus returns, and the domains and users arrays.

 

verify_error

string

A message that explains the reason for a verification error.

The function returns this value in the payload hash.

A human-readable error message.DEPTH_ZERO_SELF_SIGNED_CERT

subject.commonName

string

The certificate's common name.

The function returns this value in the payload hash.

A valid domain.example.com

domains

array

The domains that the CSR covers.

The function returns this value in the payload hash.

A valid domain or domains.
example.servername.com
example.com
mail.example.com
www.example.com
www.example.servername.com

is_self_signed

Boolean

Whether the certificate is self-signed.

The function returns this value in the payload hash.

  • 1 — Self-signed.
  • 0 — Not self-signed.

     

0

created

integer

When the certificate was created.

The function returns this value in the payload hash.

A date in Unix time format.1496950287

users

array

The owner of the cPanel account.

The function returns this value in the payload hash.

A valid cPanel username on the server.example

validation_type

string

The certificate's validation type.

The function returns this value in the payload hash.

  • ev — Extended Validation.
  • ov — Organization Validated.
  • dv — Domain Validated.
  • null — The system could not parse and determine the certificate's validation type.
dv

issuer.organizationName

string

The certificate's organization.

The function returns this value in the payload hash.

A valid string.Organization

friendly_name

string

The certificate's friendly name.

The function returns this value in the payload hash.

A valid string.
example.com and www.example.com

issuer.commonName

string

The name that issued the certificate.

The function returns this value in the payload hash.

A valid domain.example.servername.com

signature_algorithm

string

The signature algorithm of the certificate.

The function returns this value in the payload hash.

A valid OID hash algorithm name.sha256WithRSAEncryption

not_before

integer

When the certificate started.

The function returns this value in the payload hash.

A date in Unix time format.1496950286

modulus_length

integer

The length of the certificate's modulus.

The function returns this value in the payload hash.

A positive integer.2048

not_after

integer

When the certificate expired.

The function returns this value in the payload hash.

A date in Unix time format.1528486286

cab

string

The CA bundle's contents.

The function returns this value in the payload hash.

A valid CA bundle.
 Click to view...
-----BEGIN CERTIFICATE-----
MIIB+jCCAWMCAgGjMA0GCSqGSIb3DQEBBAUAMEUxCzAJBgNVBAYTAlVTMRgwFgYD
VQQKEw9HVEUgQ29ycG9yYXRpb24xHDAaBgNVBAMTE0dURSBDeWJlclRydXN0IFJv
b3QwHhcNOTYwMjIzMjMwMTAwWhcNMDYwMjIzMjM1OTAwWjBFMQswCQYDVQQGEwJV
UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMRwwGgYDVQQDExNHVEUgQ3liZXJU
cnVzdCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC45k+625h8cXyv
RLfTD0bZZOWTwUKOx7pJjTUteueLveUFMVnGsS8KDPufpz+iCWaEVh43KRuH6X4M
ypqfpX/1FZSj1aJGgthoTNE3FQZor734sLPwKfWVWgkWYXcKIiXUT0Wqx73llt/5
1KiOQswkwB6RJ0q1bQaAYznEol44AwIDAQABMA0GCSqGSIb3DQEBBAUAA4GBABKz
dcZfHeFhVYAA1IFLezEPI2PnPfMD+fQ2qLvZ46WXTeorKeDWanOB5sCJo9Px4KWl
IjeaY8JIILTbcuPI9tl8vrGvU9oUtCG41tWW4/5ODFlitppK+ULdjG+BqXH/9Apy
bW1EDp3zdHSo1TRJ6V6e6bR64eVaH4QwnNOfpSXY
-----END CERTIFICATE-----

id

string

The certificate's identification.

The function returns this value in the payload hash.

A valid string.
example_servername_com_ce52d_6e643_2813308004_119580f9b01960cjones72bc519206bc
                

key

string

The private key's text.

The function returns this value in the  payload   hash.

A valid private key in Base64 PEM format. 
 Click to view …
-----BEGIN RSA PRIVATE KEY-----
MIIJJwIBAAKCAgEA4yilqsoCdEpiNOyLcPJ4FLT7vgwaLdOBeJLTMUeV2uZM4v65
/tiZe7H0soDp1C55SCr3uEIEa7Lq7RUZ+F5p67BgRR19rmerKGxfN7N5Vu97pfTw
W1f+lVsxUF/56lVeoAmm4okU98xJHiGGlI8ZHGJbUMYfLPy0OrA+gNwMHqMVOv1B
SgpbEWCILMvnvtp0rwPutjnPVX2Dj40ia40L4Wqvp+0Yg7mZyhIOl+q6VZVIdXZs
lR4ZywfRBYt3ieFBDYMyNw9wN3Xy44fCpHc77+ho84W3BqrGaWSSDyf6UkZGD5mf
ohGf2JSp+c8J6H7hsxo7pta3K1diVXFOSfnaA+k56zW445XruwYs/SN/zvGetGi6
uqhMAcVRQcYCmLCixcC6RkcUx3exxgR4q3gthDnFvWC4+NuTh8/K0BcxcuCEhRug
/MfVfO3+f7RJFSJPFb9m9Lf4HHBSVkDP5WtG4XiBKCe++9Wuvxbd4QxS7YrnSopN
KxkuHKswH8ONpADMYDqfLODMhNrslHNHu95Nv7AlQr8weLqMGWMp7GFqzXcl39Rn
VkF4Bxd3bAAsMN8/JvanMKCPjTTDrfzVFZcmHXPYOljYDdY1xfIstYVtbyFkUHZP
2RPPBaPUAt90lzrKGVF8a2vdIKRiey5SZ5qu9c/mGri3oz7Lkk7qkNPAqDMCAwEA
AQKCAgA3f9raG3j2CKZt381Bzzvfc0h+al6LC736Q4Ut6RuH2/S1ER9IUItPWW87
nZuDp8ciBr13W0nRNmmHezxZHlgqqXEb8dSfI90Bh1jMNyFSSDihl3KSHrGotBsc
VBavViREXZdUicGBuXuxtkYno96yvKUq2v0K9MLkA+OBgEHFynqJaw7klBsj573d
lAQO8TjI+eD8zKsHbB8Ul5rtRAy/Cl3YXWk75cDZSggevc7A0jRd3o0w8aXDoSlE
fYq7OTm3n3JJWZBFPKAXTzgTDr6qItJhjS4IxXsq7RNyeIYES/8aGKKT6lJvjALr
cdYt47IpHCOu447lG/h+f6xtDophLGZoAirO7lJFRVfLJh76sLF12bpXJKbbmMN+
aut0nM+MLEw8A5K9OV24jJ/3+afj//5789asIyvNaQFPOX23SdLX0QbA5QWvJt2t
WvvpS3ubcIJaBEMTK8asEBC68eUW0BBKJaSiYNzecUFYCBjQlxKsIrYuWZoW6fMy
Rel+cnqMdiH7r2p6RmgF5c9myDwq3E47jE+VrOy8uhw7EMQvT8+YSKaIbgtFZcUS
U02BDRB7gWNa842m6nGs5tj5xFNQ6Wt410vilTwL+6zCQqJaKmcdE3woiIgSdrw5
MssAHHjqo7QJthZfbpUAUTc6jGPNO13U1ediIRAGdQW5ALqTwQKCAQEA884bmFFZ
LTewHIv1PJFfNxVZfk3C7LhWE2JcI/5P/YrN4ZA8G08OYhgxqa5XnsHHQPwMM85i
1HeOoPwqgTMIyLDX/Sf88+eW3ef4V2M1Y4op0ahWFEwbwXKGxOhncElObN7dfZUw
VlxCReaiw2XQAGRqtQC0f+9dZysqPJr+Rz6poTiOtm7DcpW/WiGfBPvVhzBENyqo
uL9V3vCWYPJSLtCexECoGoPSpHKgUkwbh3+ra8SfG6FOIBj4PpMB82R7oPDjIyXF
1VDfb0EwYQlKxyZoP9+NPT2MhZv/hF/Mbm/5LolVHx92hO9q6yxS6nvaFmEPr9fY
1EOTWzzPOA+VyQKCAQEA7oVioaTqxENt+wHITZq100iYUpm4X1N1eENTp97QyQbQ
OVR/t8iGLUdvOZdIxBSTS3JFQ8TNcGDPPc+o319QGdZABNnKwFGY3Ss+5QgVeX6n
0WKdxCRelUOUB174aBeXcJCKplh6xBUrLfSZxvZQQb7fv0Mb+2eKUBKTymvES1kp
Ydn1T0vCCHA3bVpaHuqliCoDSX3RmQICZlfSgCGBbAkmU8RuxDd9yR9l7O9MXUmL
sqlsw6hvbUt+7Y13YlDtyX8gbCwEEYsoALOotY1xNfXnyZKTAXhrg+xsQLrURYZU
oZiCJyK/mHCWRTPVkt89wq4IexbJ9hqlRjzpmlr8GwKCAQBxRSCs855q06SOnreh
HCkQfmrFs3sMX9gdyWTllBG1yfc9BLXoOiKEkJkCLG2o5H6eQnuo1go0jBdH0+Ar
hnpeQ0sV4q4y4zXEgzFt6Dm1tUsYjQzxASskBQF4GkF0eZpmGmTtI5MBjHt93llg
Tr0EcaLh1SIHDj5m4DcPUTMyBnro3E3xlCRZ6Biu10/6EMZzuIj42Gjq7HoIyd4T
zIFCHsqkgyWWrAgBPwAdPB7OJRKPTxpcy+RwJSmwaLxPSC/n5gKhIbt4D8q+9Zp0
esyzGbT1d/c2rJHMwV1FMvzXkk5CwKs7enKl8FXMTRt4tXHtU8rl93JVq8+aY/Yi
JZuBAoIBAERG2lz7IFjeFHVtpTDRwIqilTfP2P8wnMe4PhInrgxdbu16SrUJKZ98
e1I5BBNc8G0AYONtSoGItMo0z1phpkQ/GERLM8aplOB6qJ5XGg6VOuStHgwvfQOt
PIp/nQvu9OK7/XRwj3Phu2KESiCyEXdAdDwDsdbdZLJXHwcqoh4Pf9EK2zW/seNI
fBVJb9K5yHiZzicTZRQvhxBUw2T6MloCpH4GFM8GM3OHEV4pgeqSSvLxnLjFVmAq
5EKL5Ei4cdjkExvj3aZH90N8KicOPgH8SkVhN8OL/Prein5c/LaKJV+8kEUzpTS1
xc45cEGCteMsfjD97QINzpG0jgopUVECggEADIaKsx8NUQT3hm0wHRanEFJnQH5H
zxaQjWbsjm2uz0KROPNIK1X5L8kypsb+EzlJtvWUqxPaOaTv4DZVpFaVzk8/2PPG
sYR3mUjqMqNFYMrNwYZAXvJ/huzDPqq6+w2Pn9jcAifHNw3S8UR650v8gl7BU4fV
BvhamG8JelvwLqeGWoikST9NBXVqG5IKBpUkUiFOMUNmRih9ooKvhy7GosoK8MWb
mhWo1v8TTSXSagACUhAoIzb6mMN/VFC5WDbFx5AEB/G9tq/zmTqQkuo39dvgl30w
yZGRNwc1aFf1Kxeven10/JN9ipp0mTa7NYSdn0RAe9ZRp5cCkgmktqmB0g==
-----END RSA PRIVATE KEY-----

crt

string

The certificate's contents.

The function returns this value in the payload hash.

A valid certificate file in Base64 PEM format.
 Click to view …

-----BEGIN CERTIFICATE-----
MIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ
c2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI
DAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy
MjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV
BAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G
CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P
Xx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW
voK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da
M3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC
+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6
PLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj
UDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw
+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA
A4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh
cDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw
FYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh
/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag
qz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa
Km6r7YmwfLN/YMZBHXSR58oOGP9W
-----END CERTIFICATE-----


modulus

string

The certificate's modulus.

The function returns this value in the payload hash.

A valid string.
 Click to view …
ce52db786fd2776f69057ed8ee0d8ab267a2f328a66a3afd8
76017a99d061ec5d24d646f80ec258c696cb742e2bcd2fef920177144d9126a4
779c1a21ca5589ff06e673556116903493100dfba385a62d11aeec57f47e5b20
ad8d1142fbe93f003fb62403cdcc0012ccd407009ac21639623bc52a5d6d3814
ff9c45a7c246799f0229b4854af2aeddfa755ab13814132424f5b1680f2c357e
1476af7422bd5863102cfc5982b3ddad7fecdeae5c1cb73789008be9ce2f24fe
27c9202b3bca6524ba29a30972f14cbf06f0a1b7998c2361ed90221f40829faf
644adc7b8da6f948d8745ffbe8e5b6f0c8e7ea9ef2bc26413f90666ef1200407
eab7c3b71c6e643