---
title: "Install SSL certificate"
method: GET
path: "/SSL/install_ssl"
tags: ["SSL", "SSL Certificate Management"]
---

# Install SSL certificate

`GET /SSL/install_ssl`

This function installs an SSL certificate.

**Note:**

Due to their inherent complexities, SSL-related functions often present problems for third-party developers. For the additional steps required to successfully call this function, read our [Call UAPI's SSL::install_ssl Function in Custom Code](https://go.cpanel.net/tutorial-call-uapis-ssl-install-ssl-function-in-custom-code) documentation.

**Important:**

When you disable the *Calendars and Contacts*, *Receive Mail*, *Web Disk*, *Webmail*, and *Web Server* [roles](https://go.cpanel.net/serverroles), the system **disables** this function.

## Query parameters

- `cert` string, pem-certificate, required
- `domain` string, domain, required
- `cabundle` string, pem-certificate
- `domain_dcv_method` object
- `key` string, pem-private-key
- `order_item_id` string
- `originating_certificate_id` string
- `parent_cert_expiry` integer
- `vhost_names` string[]

## 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
      - `action` string — The action that the function used to install the certificate.
      - `cert_id` string — The certificate ID.
      - `domain` string, domain — The domain that the certificate covers.
      - `extra_certificate_domains` string[] — The domains that require extra certificates for mail and other services.
      - `html` string — The results, in HTML format.
      - `ip` union — The domain's IP address.
        - string, ipv4
        - string, ipv6
      - `key_id` string — The key ID.
      - `message` string — The results, in text format.
      - `statusmsg` string — The results.
      - `user` string, username — The domain's owner.
      - `warning_domains` string[] — The domains that the certificate does not cover.
      - `working_domains` string[] — The domains that the certificate covers.
    - `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)