Return AutoSSL renewal status for a domain

This function returns the AutoSSL renewal status for a domain. It indicates whether AutoSSL is active, the domain is excluded, the domain has DCV problems, and whether the certificate will auto-renew.

get/SSL/get_autossl_renewal_status

Request

Base URL
https://cpanel-server.tld:2083/execute
Auth
HTTP basic

Query parameters

domainstring required

Example:example.com

The fully qualified domain name to check.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_autossl_renewal_status",
  "module": "SSL",
  "result": {
    "data": {
      "is_active": 1,
      "will_renew": 1
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.