# Return domains with SSL certificate information

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, the system disables this function.

Endpoint: GET /SSL/installed_hosts
Version: 11.137.9999.106
Security: BasicAuth

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "installed_hosts"

  - `module` (string)
    The name of the module called.
    Example: "SSL"

  - `result` (object)

  - `result.data` (array)

  - `result.data.certificate` (object)
    An object that contains information about each certificate.

  - `result.data.certificate.auto_ssl_provider` (string)
    The AutoSSL provider's name.
    Example: "cPanel"

  - `result.data.certificate.auto_ssl_provider_display_name` (string)
    The AutoSSL provider's display name.
    Example: "Sectigo"

  - `result.data.certificate.domains` (array)
    The domains that the certificate covers.
    Example: ["example.com"]

  - `result.data.certificate.ecdsa_curve_name` (string,null)
    The ECDSA curve that the certificate's key uses.

* prime256v1
* secp384r1
* null — The certificate's key is not an ECDSA key.
    Enum: "prime256v1", "secp384r1"

  - `result.data.certificate.ecdsa_public` (string,null)
    The certificate's key's ECDSA compressed public point, in hexadecimal format.

* null — The certificate's key is not an ECDSA key.

  - `result.data.certificate.id` (string)
    The certificate's ID.
    Example: "example_com_a74f7_9dddf_1446659822_eae1ff43c4ec1991e195877c55755eff"

  - `result.data.certificate.is_autossl` (integer)
    Whether the AutoSSL service provided the certificate.
* 1 - Provided by the AutoSSL service.
* 0 - Not provided by the AutoSSL service.
    Enum: 0, 1

  - `result.data.certificate.is_self_signed` (integer)
    Whether the certificate is self-signed.
* 1 - Self-signed.
* 0 - Not self-signed.
    Enum: 0, 1

  - `result.data.certificate.issuer.commonName` (string)
    The name that issued the certificate.
    Example: "example.com"

  - `result.data.certificate.issuer.organizationName` (string)
    The certificate's organization name.
    Example: "The Example Organization"

  - `result.data.certificate.issuer_text` (string)
    The issuer's X.509 information.
    Example: "example.com\ncountryName\nUS\nemailAddress\nusername@example.com\norganizationName\nExample\nstateOrProvinceName\nTexas\nlocalityName\nHouston"

  - `result.data.certificate.key_algorithm` (string)
    The certificate's key's algorithm.

* rsaEncryption — RSA.
* id-ecPublicKey — ECDSA.
    Enum: "rsaEncryption", "id-ecPublicKey"

  - `result.data.certificate.modulus` (string,null)
    The certificate's key's modulus, in hexadecimal format.

* null — The certificate's key is not an RSA key.
    Example: "a673c3b17344664b35f8791f562d3aea6bf4d8faa3ae3fc0a519380fd453964a36677c34d48677ecb7f5ed035df026f5f0f8fbfe21745e52daf1f3b9e58c73f0baefdb709320e2202e7d05250b051a59b30ff1fef22d83d7140c1c81cea314a0890ce8d2226799872181c58a74016c7aaa2cff5ac72b575cecde8f304aa572a2ea03d8b173ab76c6e8cdb9dfd0da81e1119cefd4b8b4dbfbe0e46c7f1ee2fe8b5fd5504e58ccbc0d13b4fa41ecc9ebd0dabe1d1fec5c724f748167e7c0553e997f9b77eb36abce70973f06df151748d41b758de3efd7afa6f2464a1547f5ff158469d96e248be464df9eda0e7ce854a89332a2c1278b17c425368a9604f454db"

  - `result.data.certificate.modulus_length` (integer,null)
    The length, in bits, of the certificate's key's modulus.

* null — The certificate's key is not an RSA key.
    Example: 2048

  - `result.data.certificate.not_after` (integer)
    When the certificate expired.
    Example: 1446659822

  - `result.data.certificate.not_before` (integer)
    When the certificate started.
    Example: 1415123822

  - `result.data.certificate.signature_algorithm` (string)
    The signature algorithm of the certificate.
    Example: "sha256WithRSAEncryption"

  - `result.data.certificate.subject.commonName` (string)
    The certificate's common name.
    Example: "example.com"

  - `result.data.certificate.subject_text` (string)
    The subject's X.509 information.
    Example: "commonName\nexample.com"

  - `result.data.certificate.validation_type` (string,null)
    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.
    Enum: "ev", "ov", "dv"

  - `result.data.certificate_text` (string)
    The certificate's text.
    Example: "-----BEGIN CERTIFICATE-----\nMIIDcTCCAlmgAwIBAgIFAU+BNVgwDQYJKoZIhvcNAQEFBQAwUTESMBAGA1UEAwwJ\nc2lza28udGxkMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGY1BhbmVsMQswCQYDVQQI\nDAJUWDEQMA4GA1UEBwwHSG91c3RvbjAeFw0xNDEwMDYyMjI2MTlaFw0xNTEwMDYy\nMjI2MTlaMFExEjAQBgNVBAMMCXNpc2tvLnRsZDELMAkGA1UEBhMCVVMxDzANBgNV\nBAoMBmNQYW5lbDELMAkGA1UECAwCVFgxEDAOBgNVBAcMB0hvdXN0b24wggEiMA0G\nCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9zx6zGiHdmWA0dKtoXmJiWXpZ9E3P\nXx3YHsjFEWW7e5pH0vZ+jVMzDmm5nsJ7RXrAkZO1IvpIpVLvoQfiJOWVvkD+o9fW\nvoK1tWJS72FSgPju+58mA2ieBuc87A790Pzuv1P3NR3zFLAjUR99zkHR1fpri/da\nM3PBWO8ET48FWkyU1kOeZaUlF67/+wrEiNgg+t1qhKOCAB61PdNVkLaSGHimksuC\n+Czk8Kq9nuS0E0TCnDtjjEyJ455FUcaCfczlTb8xkB/F9ORe74yTzD+vlk0tFMG6\nPLj/ajIwWqwO0qmQ8wX3NRxkWgGz5kVO1wrVJarKQ5EYQ3/mgvit0v6dAgMBAAGj\nUDBOMB0GA1UdDgQWBBRw+wKBo34+bgexjAa3EMDsgSCd7zAfBgNVHSMEGDAWgBRw\n+wKBo34+bgexjAa3EMDsgSCd7zAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUA\nA4IBAQCHRXIs53opzKM2rM8Qe8lcw524WK6hqy2EWrZHp78N7rU7/6DQ/I3hv3Wh\ncDDIO04I2/Xhe88MLBaLoM367Ya+vy7CaLr14aLi/SfQszMA0ALBvMao+Fis0iVw\nFYq/NLgSXw+fgnpFskt8v8iQZ+4Kaal8U8e9sVgu8m0RgO7rzym1eRiIKpsKd1rh\n/SD7LbSN7M7TRL3QqF7ltw9sQhAAsQcRaBBF21pdWrqhiGZ+Eioo3hhgwNavH2ag\nqz78ddHwrFpHFwrEeUk1OfpPb76MYIce7xIy/4oQNdg6fOq4l/FrajBv+WkzDVPa\nKm6r7YmwfLN/YMZBHXSR58oOGP9W\n-----END CERTIFICATE-----"

  - `result.data.docroot` (string)
    The document root of the domain that the certificate covers.
    Example: "/home/username/public_html"

  - `result.data.domains` (array)
    The domains that the certificate covers.
    Example: ["example.com"]

  - `result.data.fqdns` (array)
    An array of every valid fully qualified domain
name (FQDN) on the virtual host, which includes service
subdomains (proxy subdomains).
    Example: ["www.example.com"]

  - `result.data.ip` (any)
    The host's IP address.
    Example: "192.168.0.1"

  - `result.data.is_primary_on_ip` (integer)
    Whether the website is primary on the IP address.
* 1 - Primary.
* 0 - Not primary.
    Enum: 0, 1

  - `result.data.mail_sni_status` (integer)
    Whether SNI is active on the domain.
* 1 - Active.
* 0 - Inactive.
    Enum: 0, 1

  - `result.data.needs_sni` (integer)
    Whether the website requires SNI to function.
* 1 - Requires SNI.
* 0 - Does not require SNI.
    Enum: 0, 1

  - `result.data.servername` (string)
    The server's hostname.
    Example: "example.com"

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.metadata.transformed` (integer)
    Post-processing may have transformed the data.
    Enum: 1

  - `result.status` (integer)
    * 1 - Success
* 0 - Failed: Check the errors field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.