---
title: "Return domains with SSL certificate information"
method: GET
path: "/SSL/installed_hosts"
tags: ["SSL", "cPanel Account SSL Management"]
---

# Return domains with SSL certificate information

`GET /SSL/installed_hosts`

This function retrieves a list of the account's websites, their domains, and certificate information.

**Important:**

  For a dedicated IP address, use the UAPI `SSL::installed_host` function.

**Important:**

 When you disable the *CalendarContact* , *MailReceive* , *WebDisk* , *Webmail* , and  *WebServer* [roles](https://go.cpanel.net/serverroles), the system **disables** this function.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[]
      - `certificate` object — An object that contains information about each certificate.
        - `auto_ssl_provider` string — The AutoSSL provider's name.
        - `auto_ssl_provider_display_name` string — The AutoSSL provider's display name.
        - `domains` string[] — The domains that the certificate covers.
        - `ecdsa_curve_name` 'prime256v1' | 'secp384r1', nullable — The ECDSA curve that the certificate's key uses. * `prime256v1` * `secp384r1` * `null` — The certificate's key is **not** an ECDSA key.
        - `ecdsa_public` string, nullable — The certificate's key's ECDSA compressed public point, in hexadecimal format. * `null` — The certificate's key is **not** an ECDSA key.
        - `id` string — The certificate's ID.
        - `is_autossl` 0 | 1 — Whether the AutoSSL service provided the certificate. * `1` - Provided by the AutoSSL service. * `0` - Not provided by the AutoSSL service.
        - `is_self_signed` 0 | 1 — Whether the certificate is self-signed. * `1` - Self-signed. * `0` - Not self-signed.
        - `issuer.commonName` string, domain — The name that issued the certificate.
        - `issuer.organizationName` string — The certificate's organization name.
        - `issuer_text` string — The issuer's X.509 information.
        - `key_algorithm` 'rsaEncryption' | 'id-ecPublicKey' — The certificate's key's algorithm. * `rsaEncryption` — RSA. * `id-ecPublicKey` — ECDSA.
        - `modulus` string, hex, nullable — The certificate's key's modulus, in hexadecimal format. * `null` — The certificate's key is **not** an RSA key.
        - `modulus_length` integer, nullable — The length, in bits, of the certificate's key's modulus. * `null` — The certificate's key is **not** an RSA key.
        - `not_after` integer — When the certificate expired.
        - `not_before` integer — When the certificate started.
        - `signature_algorithm` string, sha256 — The signature algorithm of the certificate.
        - `subject.commonName` string, domain — The certificate's common name.
        - `subject_text` string — The subject's X.509 information.
        - `validation_type` 'ev' | 'ov' | 'dv', nullable — The certificate's validation type. **Note:** * `ev` - Extended Validation. * `ov` - Organization Validation. * `dv` - Domain Validation. * null - The system could not parse and determine the certificate's validation type.
      - `certificate_text` string, pem-certificate — The certificate's text.
      - `docroot` string, path — The document root of the domain that the certificate covers.
      - `domains` string[] — The domains that the certificate covers.
      - `fqdns` string[] — An array of every valid fully qualified domain name (FQDN) on the virtual host, which includes service subdomains (proxy subdomains).
      - `ip` union — The host's IP address.
        - string, ipv4
        - string, ipv6
      - `is_primary_on_ip` 0 | 1 — Whether the website is primary on the IP address. * `1` - Primary. * `0` - Not primary.
      - `mail_sni_status` 0 | 1 — Whether SNI is active on the domain. * `1` - Active. * `0` - Inactive.
      - `needs_sni` 0 | 1 — Whether the website requires SNI to function. * `1` - Requires SNI. * `0` - Does not require SNI.
      - `servername` string, domain — The server's hostname.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — * `1` - Success * `0` - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)