UAPI Functions - SSL::installed_host - Knowledgebase

Description

This function retrieves information about a certificate that is installed on a domain's IP address.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/SSL/installed_host?domain=example.com

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve certificate information for example.com domain's IP address.

$SSL_installed_host = $cpanel->uapi(

'SSL', 'installed_host', array(

'domain' => 'example.com',

)

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Retrieve certificate information for example.com domain's IP address.

my $SSL_installed_host = $cpliveapi->uapi(

'SSL', 'installed_host', {

'domain' => 'example.com',

}

);

cPanel Template Toolkit

[% data = execute( 'SSL', 'installed_host', { domain => 'example.com'} ); %]

[% FOREACH q = data %]

<p>

[% q %]

</p>

[% END %]

Command Line

uapi --user=username SSL installed_host domain=example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "certificate": {
      "owner": {
        "username": null
      },
      "is_self_signed": "1",
      "validation_type":"dv",
      "signature_algorithm":"sha256WithRSAEncryption",
      "issuer.organizationName": "Organization",
      "signature_algorithm":"sha256WithRSAEncryption",
      "modulus": "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db",
      "subject.commonName": "example.com",
      "not_before": "1365633490",
      "modulus_length": "2048",
      "host": "example.com",
      "not_after": "1397169490",
      "created": "1365633887",
      "domains": [
        "example.com"
      ],
      "text": "-----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-----
 
 
",
      "issuer.commonName": "example.com",
      "id": "example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041",
      "issuer_text":
  
"commonName\nexample.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston"
    },
    "host": "example.com"
  }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
domain	string	Required The domain name.	A valid domain name.	example.com

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain name.

A valid domain name.

example.com

Returns

Return	Type	Description	Possible values	Example
certificate	hash	A hash of the certificate information.	This hash includes the owner,is_self_signed,issuer.organizationName, modulus,subject.commonName, not_before,modulus_length, host,signature_algorithm,validation_type, not_after,created, domains, text,issuer.commonName, id, andissuer_text returns.
owner	string	The account owner. The function returns this value in the certificatehash.	A valid username.	example
is_self_signed	Boolean	Whether the certificate is self- signed. The function returns this value in the certificatehash.	1 — Self-signed. 0 — Not self-signed.	1
validation_type	string	The certificate's validation type. Note: We introduced this return in cPanel & WHM version 56. The function returns this value in the certificatehash.	ev — Extended Validation. ov — Organization Validation. dv — Domain Validation. undef — The system could not parse and determine the certificate's validation type.	dv
signature_algorithm	string	The signature algorithm of the certificate. Note: We introduced this return in cPanel & WHM version 56. The function returns this value in thecertificatehash.	A valid OID hash algorithm name.	sha256WithRSAEncryption
issuer.organizationName	string	The certificate's organization. The function returns this value in the certificatehash.	A valid string.	Organization
modulus	string	The certificate's modulus. The function returns this value in the certificatehash.	A valid string.
subject.commonName	string	The certificate's Common Name. The function returns this value in the certificatehash.	A valid domain name.	example.com
not_before	integer	The certificate's start time. The function returns this value in the certificatehash.	A date in Unix time format.	1365633490
modulus_length	integer	The modulus' length. The function returns this value in the certificatehash.	A positive integer.	2048
host	string	The IP address' hostname. The function returns this value in the certificatehash.	A valid domain name.	example.com
not_after	integer	The certificate's expiration time. The function returns this value in the certificatehash.	A date in Unix time format.	1397169490
created	integer	When the certificate was created. The function returns this value in the certificatehash.	A date in Unix time format.	1365633887
domains	array	The domains that the certificate covers. The function returns this value in the certificatehash.	A valid domain or list of domains.	example.com
text	string	The certificate's text. The function returns this value in the certificatehash.	A valid certificate file in Base64 PEM format.
issuer.commonName	string	The issuer's name. The function returns this value in the certificatehash.	A valid string, typically a domain name.	example.com
id	string	The certificate's ID. The function returns this value in the certificatehash.	A valid string
issuer_text	string	The X.509 information about the issuer. The function returns this value in the certificatehash.	A string that contains CSR information.
host	string	The issuer's hostname.	A valid domain name.	example.com

Knowledgebase

Categories

Categories