v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

SSL

cPanel Account SSL Management

Return SSL certificate's info for dedicated IP

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

Important:

If you do not possess a dedicated IP address, this function will fail. For non-dedicated IP addresses, use the SSL::installed_hosts function.
When you disable the Calendars and Contacts, Receive Mail, Web Disk , Webmail , and Web Server roles, the system disables this function.

get/SSL/installed_host

Query parameters

domainstring domain

Example:example.com

The domain name.

Note:

The parameter defaults to the account's main domain.

verify_certificate0 | 1

Example:1

Verify the certificate.

1 — Verify the certificate.
0 — Do not verify the certificate.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "installed_host",
  "module": "SSL",
  "result": {
    "data": {
      "certificate": {
        "domains": [
          "example.com"
        ],
        "ecdsa_curve_name": "prime256v1",
        "id": "example_com_c69ce_37ff5_1397169490_169c717cb2c260281df792788accf041",
        "is_self_signed": 1,
        "issuer.commonName": "example.com",
        "issuer.organizationName": "Organization",
        "issuer_text": "commonName\nexample.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston",
        "key_algorithm": "rsaEncryption",
        "modulus": "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db",
        "modulus_length": 2048,
        "not_after": 1397169490,
        "not_before": 1365633490,
        "signature_algorithm": "sha256WithRSAEncryption",
        "subject.commonName": "example.com",
        "subject_text": "commonName\nexample.com",
        "validation_type": "dv"
      },
      "host": "example.com"
    },
    "status": 1
  }
}