---
title: "Install SSL certificate"
method: GET
path: "/installssl"
tags: ["SSL", "cPanel Account Settings"]
---

# Install SSL certificate

`GET /installssl`

This function installs an SSL certificate.

## Query parameters

- `crt` string, required
- `domain` string, domain, required
- `key` string, required
- `cab` string
- `ip` string, ipv4

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `action` 'install' — The action for the function to execute.
    - `aliases` string[] — A list of domain aliases on the account.
    - `domain` string, domain — The domain on which the function installed the SSL certificate.
    - `extra_certificate_domains` string[] — A list of domains that possess additional SSL certificates.
    - `html` string — The function's raw HTML output.
    - `ip` string, ipv4 — The domain's IP address.
    - `message` string — A message of success or a reason for failure.
    - `servername` string, hostname — The server's hostname.
    - `status` 1 | 0 — Whether the function was successful. * `1` — Success. * `0` — Failure.
    - `statusmsg` string — A message of success or a reason for failure.
    - `user` string, username — The username for the account on which the function installed the SSL certificate.
    - `warning_domains` string[] — A list of domains associated with the main domain on which the function did **not** install the SSL certificate.
    - `working_domains` string[] — An list of domains on which the function installed the SSL certificates.
  - `metadata` object
    - `command` string — The method name called.
    - `output` string — The function's raw HTML output.
    - `reason` string — The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.
    - `result` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

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