Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves information about a certificate.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/fetchcrtinfo?api.version=1&user=example&id=example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/fetchcrtinfo?api.version=1&user=example&id=example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd
 Command Line
whmapi1 fetchcrtinfo user=example id=example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd

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. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "data": { 
     cabundle: "-----BEGIN CERTIFICATE-----\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/MSQwIgYDVQQK\nExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMTDkRTVCBSb290IENBIFgzMB4X\nDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0NlowSjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxl\ndCdzIEVuY3J5cHQxIzAhBgNVBAMTGkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4\nS0EFq6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8SMx+yk13\nEiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0Z8h/pZq4UmEUEz9l6YKH\ny9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWAa6xK8xuQSXgvopZPKiAlKQTGdMDQMc2P\nMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQAB\no4IBfTCCAXkwEgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEE\nczBxMDIGCCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNvbTA7\nBggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9kc3Ryb290Y2F4My5w\nN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAwVAYDVR0gBE0wSzAIBgZngQwBAgEw\nPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcCARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNy\neXB0Lm9yZzA8BgNVHR8ENTAzMDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9P\nVENBWDNDUkwuY3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\nAAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJouM2VcGfl96S8\nTihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/wApIvJSwtmVi4MFU5aMqrSDE\n6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwuX4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPM\nTZ+sOPAveyxindmjkW8lGy+QsRlGPfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M\n+X+Q7UNKEkROb3N6KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n-----END CERTIFICATE-----";
     certificate: "-----BEGIN CERTIFICATE-----\nMIIGeDCCBWCgAwIBAgISAxs2uBW3Q2TrGS/aRjTFh90EMA0GCSqGSIb3DQEBCwUAMEoxCzAJBgNV\nBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQDExpMZXQncyBFbmNyeXB0IEF1\ndGhvcml0eSBYMzAeFw0xNzA0MTcwNzU1MDBaFw0xNzA3MTYwNzU1MDBaMCUxIzAhBgNVBAMTGm9u\nZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA\nv2OGaQw5oeg2hy0LqfYlBoncBPqElkTfZGqY/2WHoKr5TawPqOlsrLzx17946KGxLs0A3J1rRpi9\nOqrHdv69tj2pFRFC1USjlQmWnUi3h//aTYFNrfDmG+lNWZQ3ALCveTQXYIAvbmwLSPxh6wdtEmU0\nGjbqDNxsI8GSrZcJ543PSTXYFvp7S1yBNSn64S5QB8WeNkLGyF0G+ieXbCJo5neJrNh6+6U+x7mT\n/VBsQDOFOMIskjKo1q56+/elzgSi6lZ5w9IXuQRB3YbbWzCC/kFmzEB/NTe9R5v1AEzdcNwWXpfi\nvlrNIktLQDYIRyHqtyrXl3uR8fvmoYf0ll+BrwIDAQABo4IDezCCA3cwDgYDVR0PAQH/BAQDAgWg\nMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMBAf8EAjAAMB0GA1UdDgQWBBQW\ns0hUTrAJo+db1I2D9K2Aa2O3STAfBgNVHSMEGDAWgBSoSmpjBH3duubRObemRWXv86jsoTBwBggr\nBgEFBQcBAQRkMGIwLwYIKwYBBQUHMAGGI2h0dHA6Ly9vY3NwLmludC14My5sZXRzZW5jcnlwdC5v\ncmcvMC8GCCsGAQUFBzAChiNodHRwOi8vY2VydC5pbnQteDMubGV0c2VuY3J5cHQub3JnLzCCAYMG\nA1UdEQSCAXowggF2giFjcGFuZWwub25lYWRheXVudGlsdGhlZGF5aWRpZS5jb22CH21haWwub25l\nYWRheXVudGlsdGhlZGF5aWRpZS5jb22CHm1wMy5vbmVhZGF5dW50aWx0aGVkYXlpZGllLmNvbYIa\nb25lYWRheXVudGlsdGhlZGF5aWRpZS5jb22CIXJhbmRvbS5vbmVhZGF5dW50aWx0aGVkYXlpZGll\nLmNvbYIid2ViZGlzay5vbmVhZGF5dW50aWx0aGVkYXlpZGllLmNvbYIid2VibWFpbC5vbmVhZGF5\ndW50aWx0aGVkYXlpZGllLmNvbYIed2htLm9uZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tgiJ3d3cu\nbXAzLm9uZWFkYXl1bnRpbHRoZWRheWlkaWUuY29tgh53d3cub25lYWRheXVudGlsdGhlZGF5aWRp\nZS5jb22CJXd3dy5yYW5kb20ub25lYWRheXVudGlsdGhlZGF5aWRpZS5jb20wgf4GA1UdIASB9jCB\n8zAIBgZngQwBAgEwgeYGCysGAQQBgt8TAQEBMIHWMCYGCCsGAQUFBwIBFhpodHRwOi8vY3BzLmxl\ndHNlbmNyeXB0Lm9yZzCBqwYIKwYBBQUHAgIwgZ4MgZtUaGlzIENlcnRpZmljYXRlIG1heSBvbmx5\nIGJlIHJlbGllZCB1cG9uIGJ5IFJlbHlpbmcgUGFydGllcyBhbmQgb25seSBpbiBhY2NvcmRhbmNl\nIHdpdGggdGhlIENlcnRpZmljYXRlIFBvbGljeSBmb3VuZCBhdCBodHRwczovL2xldHNlbmNyeXB0\nLm9yZy9yZXBvc2l0b3J5LzANBgkqhkiG9w0BAQsFAAOCAQEAbfVset/dZ+ru/K2DMa2Od4pCnRYa\nLDREL7TyAWHjHq2fHK1WbzlO9zHis+C0ezB6QBPMnrGDZns/v1njGp1gASly1pqgAsytbQdPbfHv\n/Bx1HRWywniAKSRYFxrc3k3ThrSZxDj+A9mt0znNDNUvRNuP5dGFmQzFACykgNJ58yCeUJZkD78p\n7UjpbpzxWW2m6MHlHu7dDcCwSXpCa6uE4V9TeVs3OSo42C+ZlGH2x3GeZYlOZENmG2nFw0mQFSIW\nATyQuv1Jlc7tiUGmY9o13teTN4YLColMk037Rrwb/mne3ORCPB0k7QtPtzHnCdnRio2NvwZkPXzL\nbioRoW0dQg==\n-----END CERTIFICATE-----";
     is_self_signed: 0;
     key: "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAv2OGaQw5oeg2hy0LqfYlBoncBPqElkTfZGqY/2WHoKr5TawP\nqOlsrLzx17946KGxLs0A3J1rRpi9OqrHdv69tj2pFRFC1USjlQmWnUi3h//aTYFN\nrfDmG+lNWZQ3ALCveTQXYIAvbmwLSPxh6wdtEmU0GjbqDNxsI8GSrZcJ543PSTXY\nFvp7S1yBNSn64S5QB8WeNkLGyF0G+ieXbCJo5neJrNh6+6U+x7mT/VBsQDOFOMIs\nkjKo1q56+/elzgSi6lZ5w9IXuQRB3YbbWzCC/kFmzEB/NTe9R5v1AEzdcNwWXpfi\nvlrNIktLQDYIRyHqtyrXl3uR8fvmoYf0ll+BrwIDAQABAoIBAG6cIm5LtnMwNXNi\nQT91Fmj0+8eU0VPXchQi11GjaAMfTP3q1xIT9c7PVCYQbtxjtncJ29mk0P73/0UM\ntkK7bwEIGdQnKa0AAlp8NCOqhwd+grgQZsiEVTkEWMPQuQkZFBDEXk5TRxZWMx93\nXU/r9smO29HasuHD8mun0BGrHPpJJm6JE8iMT9wIrr4pYb5TLtXtO/yQ5rxsT5uB\nbmuXAHZ51brj+aIdjrYNAVYHPvVDAjs7aHgKjbLvJ7DJPJKSbkbAEYKqT7lyQO5x\nGtLk1K5qKNHc1sFyybBF/LO1Tn7xTMbSuKce/AUvgE76RZ0nkvCD/kY1l3WBH2ns\nYFsojsECgYEA7UgMJgoKnerhmG/mnZqPUXb78PVgZmt0zmlAYRAcLc8K19xPKVOK\nz4HcDmfkPdkpsdp1YXJ6K/ueJOXq0aCFh2E+uYyqvsMQDFp72poxUPPlJ5zoj3jG\n6N9owoV2CuWX0QbhsE4/Hu5sVjBdE8WuqBBUqKp6602YV8YrA018bSkCgYEAznyq\nLhQujrpeqlN/HRhpNne5r5D8F4wQSZmFP9eRP1pnO2TQqY/wXJgOMKT20CcqwiiY\noVuOmQs1W3dz/MlWHanRKL5cIcF26Pgsp1jimD13JwPU/7nH4+CzJmkXGSHbNmQf\n2wvjv+jni2PbTZ5sotESziaJAdbcRAdg39KnexcCgYEAj086dycNbn9ULZs4L+wP\nr2YrmEa7KGCyNZCAH595RXmM1P7smMsqRVXrMJAy29/zPMXyqx5XB4V66FIs1tsa\nir+DANIitgBeCvgDYe5K5tfHiXtNQonxqOh1/zZYKxCr9sUvPiqkGOxrZkrjjHOS\nn1Ltrsj4YHGHF0xK4j3EbrECgYB403ANqJeZwyqTxmoST295hNNuDYvGB5qcRq43\nLl/6z16q3ZJQNj7zH7Ll+hHGubSGipTNjrLBkVJ2pE6FtBalIvKWQdXNltSK/HW8\nswFdDlKDzPU9cquqB5ktN79hYHNSv4H4fluVt6aN5S+1mqd9GpRDdz8iiWS4lgy0\nzCJenwKBgQC61u/GsjGx4yv0c3KJHgrpIroo3HYsamAdjJBfgBGKxrxVO5J7dbvd\n84UYzp+a0XNjazMxx5rEbU3HjKV5nsHjU+Eoqpz/vwfRqbC7mqINrRQoBKtEhuOY\n+xd6W+i58dOPv7PmgxPegmZ4Fo+jHx+mNLv9L+27JPMBRwRWUxH5TQ==\n-----END RSA PRIVATE KEY-----"
     subject.commonName_ip: "192.168.0.20"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "fetchcrtinfo"
  }
}
 Output (XML)
<result>
    <data>
        <subject.commonName_ip>192.168.0.20</subject.commonName_ip>
        <is_self_signed>0</is_self_signed>
        <cabundle>"-----BEGIN CERTIFICATE-----\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/MSQwIgYDVQQK\nExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMTDkRTVCBSb290IENBIFgzMB4X\nDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0NlowSjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxl\ndCdzIEVuY3J5cHQxIzAhBgNVBAMTGkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4\nS0EFq6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8SMx+yk13\nEiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0Z8h/pZq4UmEUEz9l6YKH\ny9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWAa6xK8xuQSXgvopZPKiAlKQTGdMDQMc2P\nMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQAB\no4IBfTCCAXkwEgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEE\nczBxMDIGCCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNvbTA7\nBggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9kc3Ryb290Y2F4My5w\nN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAwVAYDVR0gBE0wSzAIBgZngQwBAgEw\nPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcCARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNy\neXB0Lm9yZzA8BgNVHR8ENTAzMDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9P\nVENBWDNDUkwuY3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\nAAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJouM2VcGfl96S8\nTihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/wApIvJSwtmVi4MFU5aMqrSDE\n6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwuX4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPM\nTZ+sOPAveyxindmjkW8lGy+QsRlGPfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M\n+X+Q7UNKEkROb3N6KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n-----END CERTIFICATE-----"</cabundle>
        <key>
            -----BEGIN
 RSA PRIVATE KEY----- 
MIIEpAIBAAKCAQEA0TtADzeV7Yw6pBMienLX2KlLbfclF8kbghExY1uqKTS0pmUh 
3hei9mmZGuuOpYY9NghcpZM7DUscrDeurWPlmXE5r4D4rCXUBaRb466CWYA42EVd 
EKqJCnUcv+QVNPrR16GKY/STkJW7xFsYhkd0fNLC9ZmuAH0hOhr/DPz1C02nWp+d 
Xh2opF6ozl3TyUCrlj94PRZyLn9/FkWMMxq63vPKrGa6bDKwA1+XaLR1oKgH+02q 
esXwOAlAIEKPbZXWq4rlYgc/rESf0o4MZ4cNR2FhrbQbgWRYTKXR6T50yewyBTHf 
xTeYBv7Wod9EmqVqaN+VMdwaSXHVI7Ws8vNiuQIDAQABAoIBAQDNxUyh6pPbtG6z 
kFH3RNy8qvqQ4l+rfdA84bXFto+pyLjlcE6Xgn11g7Lcg8+dQGEQs7aR7DNGRpmj 
UXvL8JQMjQsjbF6jxuw2xEbOq4BsjyrYn5cAXgc6rqSgn6qvmQEo5SkaVp2Ns4Sf 
fsumu713STwNmJ9EwcscvxIY7un7uxJJab7TFePIm3sjvh00Pr/qGIzXs3JrpfeB 
wMEmrlmatA09aSek/MqPQaCVrJkTnBG0rkhJeK5aucrA6a5OrKGKEbTAzcEuO5u0 
Rx+52S3SIb0ItGja6y9NmGjM0ofjE6svGxKHj6hXKw62SYnCZjmMsHh/7QDPSFxu 
hkndoZ+RAoGBAPOe8l1Mt+xwMJ64ME1dIzSmQpAcq7lRG+pFrCbx9bbDUegCfZML 
74S/ar+o8rSRUtf/kBzwWwKJsGJ8vvssA+sHBJwhD76iorN/DmH2LgXGui1N5QdO 
IGlzP/F1Zer+/bVBN8gfG874Y5oyvOqobvd9XIlT+IfIWEisjEBt8RItAoGBANvc 
9ga05rf+4UqpIfWL3NFKYNXvND1BXiav/S15vO5/Jz/p8KH1tPQUcqw6VyhbHaOs 
afoBhdSqG8nFxAvCxpU3MokgrGE+I0GHDfFWSqoQDEXF+NVHwZQq/loZO+BUao5f 
sZdMfny1zCJquXIZdHpiLAN9DGNwtgvO/0ngiQY9AoGBAIcWN+YsSEA+5XbdQ0ti 
vcbP+lDW1RHpO8Vn5NGjkVBKdfxkhSUolSPS0Gp+UDZ37qv+9fZWAOEjYD78VRoJ 
ihKkzZWVb5mRrQ5DAcKoM1TYoRvF+Z1XYPmYAnjtVBo+UohTJY8+ULkvWmuCfubP 
htiNFua/PSxtlyaVJyAC1o3xAoGAHueEPZUYCSzuhgwYFee+9jw6OFgTQ7j4fv+l 
2sqN4AhHgBhmFp3u/ZASPltE/Qsxs1v82YN1SFtQ5J/D2tNaDodftx68nD6bvg45 
y36RqC3xS610OKaJc0ZH0mpRnErBX5nb4KSD8wuq0fumbX9efAVoomTlZOTm8en6 
wGurVxECgYBWXLcLmjlOInirL0p5wDL2Qc5qWoOaLVqLxuzz+ly1uod7ruRlxZao 
At7CFatFz2XVFeAFhoRdKVdWh5QGE+QtZL6V9nZHgUoCfwMl3Xt2vpGtuYjuobu7 
rwGtjYc+LkBtubG9M/NvvBMtaTShti2X4FWcMBl7du2sDwHVFfs1UA== -----END RSA 
PRIVATE KEY-----
        </key>
        <certificate>
            -----BEGIN
 CERTIFICATE----- 
MIIEEzCCAvugAwIBAgIJALF/jFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD 
VQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD 
VQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l 
dDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH 
EwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU 
BgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ 
BgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu 
bmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV 
BAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP 
N5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl 
kzsNSxysN66tY+WZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy/5BU0+tHXoYpj 
9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M/PULTadan51eHaikXqjOXdPJQKuWP3g9 
FnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi 
Bz+sRJ/Sjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd/FN5gG/tah30SapWpo35Ux 
3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7/tALOYb7zAXbYG2+9 
AMI3xjAfBgNVHSMEGDAWgBQAlv7/tALOYb7zAXbYG2+9AMI3xjAMBgNVHRMEBTAD 
AQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a 
a9d+QG+QPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr 
HRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw 
caRtXn4uc+t6HYuW7yWesBauCWnJNiKbjN/F+uCTurN3QMAeWf3ZJtsfkAgk8dyq 
R/83a3kDtSPrpt+jX+qdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P/AAGc+ 
ZUhYoWcRWKw/y6gI7Ru++9+8+wkadL9EbKMZxhVwD5qVm4ZlWK2a -----END 
CERTIFICATE-----%0
        </certificate>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>fetchcrtinfo</command>
    </metadata>
</result>

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account's username.

A valid cPanel username.example
idstring

Required

The certificate's internal system ID.

A valid string.
example_com_bf638_f81af_1500191700_79e34f42c83f748bd49474ab9d66f7cd

Returns

ReturnTypeDescriptionPossible valuesExample

key

string

The private key's text.

A valid private key in Base64 PEM format. 
 Click to view...
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAIEAomhpdCKB+gPO5TaxKWqvWa7dGsaSnKkrdRtb4S6DQQM2EcW2Xevp1HGYZr5YK3h2SGQqhkeFG44xv\/eJCIIai8FCHV3ulWlzzt4W6akTHWET1q6bl\/aUq36OvMdsBCiZ5UkhI0+ZAEpCQWdUpBQFHxaxZuypaJbL1ITmAs\/k+x8=

is_self_signed

Boolean

Whether the certificate is self-signed.

  • 1 — Yes.
  • 0 — No.
0

subject.commonName_ip

string

The certificate's IP address.

A valid IPv4 address.example

certificate

string

The certificate's text.

A valid certificate in Base64 PEM format.
 Click to view...
-----BEGIN CERTIFICATE----- 
MIIEEzCCAvugAwIBAgIJALF/jFpw6p1bMA0GCSqGSIb3DQEBBQUAMIGfMRYwFAYD 
VQQDEw10ZXN0c2ltb24uY29tMRYwFAYDVQQLEw1Eb2N1bWVudGF0aW9uMQswCQYD 
VQQGEwJVUzEoMCYGCSqGSIb3DQEJARYZbGF1cmVuY2Uuc2ltb25AY3BhbmVsLm5l 
dDEUMBIGA1UEChMLY1BhbmVsIEluYy4xDjAMBgNVBAgTBVRleGFzMRAwDgYDVQQH 
EwdIb3VzdG9uMB4XDTEzMDUxNzE2MTMwN1oXDTE0MDUxNzE2MTMwN1owgZ8xFjAU 
BgNVBAMTDXRlc3RzaW1vbi5jb20xFjAUBgNVBAsTDURvY3VtZW50YXRpb24xCzAJ 
BgNVBAYTAlVTMSgwJgYJKoZIhvcNAQkBFhlsYXVyZW5jZS5zaW1vbkBjcGFuZWwu 
bmV0MRQwEgYDVQQKEwtjUGFuZWwgSW5jLjEOMAwGA1UECBMFVGV4YXMxEDAOBgNV 
BAcTB0hvdXN0b24wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDRO0AP 
N5XtjDqkEyJ6ctfYqUtt9yUXyRuCETFjW6opNLSmZSHeF6L2aZka646lhj02CFyl 
kzsNSxysN66tY+WZcTmvgPisJdQFpFvjroJZgDjYRV0QqokKdRy/5BU0+tHXoYpj 
9JOQlbvEWxiGR3R80sL1ma4AfSE6Gv8M/PULTadan51eHaikXqjOXdPJQKuWP3g9 
FnIuf38WRYwzGrre88qsZrpsMrADX5dotHWgqAf7Tap6xfA4CUAgQo9tldariuVi 
Bz+sRJ/Sjgxnhw1HYWGttBuBZFhMpdHpPnTJ7DIFMd/FN5gG/tah30SapWpo35Ux 
3BpJcdUjtazy82K5AgMBAAGjUDBOMB0GA1UdDgQWBBQAlv7/tALOYb7zAXbYG2+9 
AMI3xjAfBgNVHSMEGDAWgBQAlv7/tALOYb7zAXbYG2+9AMI3xjAMBgNVHRMEBTAD 
AQH/MA0GCSqGSIb3DQEBBQUAA4IBAQCxzpe71Hc7Es0dqIN7bhIFYIIgcr6wxM6a 
a9d+QG+QPH0x0KAqV8EgUbZysvyxEF0bPxW3ZAr1Is1wk80PMuU3bToFFVbFFIIr 
HRNfKLGvxiMXnZA1c6L4N0lowvXHgZxTTUXtDFLXyrcwrLsvUErEV7rbizuxqfPw 
caRtXn4uc+t6HYuW7yWesBauCWnJNiKbjN/F+uCTurN3QMAeWf3ZJtsfkAgk8dyq 
R/83a3kDtSPrpt+jX+qdjKEpRtQ5Qpm6XT2gCOQPgnfiUtOCH419pp922P/AAGc+ 
ZUhYoWcRWKw/y6gI7Ru++9+8+wkadL9EbKMZxhVwD5qVm4ZlWK2a
-----END CERTIFICATE-----%0

cabundle

string

The CA bundle certificate.

A valid CA bundle in Base64 PEM format.
 Click to view...
-----BEGIN CERTIFICATE-----\nMIIEkjCCA3qgAwIBAgIQCgFBQgAAAVOFc2oLheynCDANBgkqhkiG9w0BAQsFADA/MSQwIgYDVQQK\nExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMTDkRTVCBSb290IENBIFgzMB4X\nDTE2MDMxNzE2NDA0NloXDTIxMDMxNzE2NDA0NlowSjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUxl\ndCdzIEVuY3J5cHQxIzAhBgNVBAMTGkxldCdzIEVuY3J5cHQgQXV0aG9yaXR5IFgzMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnNMM8FrlLke3cl03g7NoYzDq1zUmGSXhvb418XCSL7e4\nS0EFq6meNQhY7LEqxGiHC6PjdeTm86dicbp5gWAf15Gan/PQeGdxyGkOlZHP/uaZ6WA8SMx+yk13\nEiSdRxta67nsHjcAHJyse6cF6s5K671B5TaYucv9bTyWaN8jKkKQDIZ0Z8h/pZq4UmEUEz9l6YKH\ny9v6Dlb2honzhT+Xhq+w3Brvaw2VFn3EK6BlspkENnWAa6xK8xuQSXgvopZPKiAlKQTGdMDQMc2P\nMTiVFrqoM7hD8bEfwzB/onkxEz0tNvjj/PIzark5McWvxI0NHWQWM6r6hCm21AvA2H3DkwIDAQAB\no4IBfTCCAXkwEgYDVR0TAQH/BAgwBgEB/wIBADAOBgNVHQ8BAf8EBAMCAYYwfwYIKwYBBQUHAQEE\nczBxMDIGCCsGAQUFBzABhiZodHRwOi8vaXNyZy50cnVzdGlkLm9jc3AuaWRlbnRydXN0LmNvbTA7\nBggrBgEFBQcwAoYvaHR0cDovL2FwcHMuaWRlbnRydXN0LmNvbS9yb290cy9kc3Ryb290Y2F4My5w\nN2MwHwYDVR0jBBgwFoAUxKexpHsscfrb4UuQdf/EFWCFiRAwVAYDVR0gBE0wSzAIBgZngQwBAgEw\nPwYLKwYBBAGC3xMBAQEwMDAuBggrBgEFBQcCARYiaHR0cDovL2Nwcy5yb290LXgxLmxldHNlbmNy\neXB0Lm9yZzA8BgNVHR8ENTAzMDGgL6AthitodHRwOi8vY3JsLmlkZW50cnVzdC5jb20vRFNUUk9P\nVENBWDNDUkwuY3JsMB0GA1UdDgQWBBSoSmpjBH3duubRObemRWXv86jsoTANBgkqhkiG9w0BAQsF\nAAOCAQEA3TPXEfNjWDjdGBX7CVW+dla5cEilaUcne8IkCJLxWh9KEik3JHRRHGJouM2VcGfl96S8\nTihRzZvoroed6ti6WqEBmtzw3Wodatg+VyOeph4EYpr/1wXKtx8/wApIvJSwtmVi4MFU5aMqrSDE\n6ea73Mj2tcMyo5jMd6jmeWUHK8so/joWUoHOUgwuX4Po1QYz+3dszkDqMp4fklxBwXRsW10KXzPM\nTZ+sOPAveyxindmjkW8lGy+QsRlGPfZ+G6Z6h7mjem0Y+iWlkYcV4PIWL1iwBi8saCbGS5jN2p8M\n+X+Q7UNKEkROb3N6KOqkqm57TH2H3eDJAkSnh6/DNFu0Qg==\n-----END CERTIFICATE-----