Sign in
SSL
cPanel Account Settings

Add SSL certificate to installation queue

This function adds SSL certificates to the installation queue. This allows you to defer and batch SSL certificate installation.

Important:

You must enter the same quantity of username, cab, crt, key, and vhost_name parameters. For example, to add three certificates to the installation queue, enter the username parameter three times, then enter three cab, crt, key, and vhost_name parameters.

get/enqueue_deferred_ssl_installations

Query parameters

cabstring required

The Certificate Authority (CA) bundle's contents.

Note:

  • We recommend that you enter an empty string. An empty string tells the server to download the CA bundle automatically.
  • To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, cab-1, cab-2, and cab-3.
crtstring required

The certificate's contents.

Note:

To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, crt-1, crt-2, and crt-3.

keystring required

The private key's text.

Note:

To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, key-1, key-2, and key-2.

usernamestring required

The cPanel account username for which to enqueue the SSL certificate installations.

Note:

To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, username-1, username-2, and username-3.

vhost_namestring domain required

The name of the web virtual host (vhost) for which to install the certificate.

Note:

To add multiple certificates to the installation queue, duplicate or increment the parameter name. For example, vhost_name-1, vhost_name-2, and vhost_name-3.

Response

HTTP Request was successful.

dataobject

Example response

{
  "metadata": {
    "command": "enqueue_deferred_ssl_installations",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes