Passa al contenuto principale

HostingSslCertificateCanInstallResponse

Successful response with one HostingSslCertificateCanInstall

errorintegerrequired

Always 0 in a successful response

Constant value: 0
messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Resource returned by the operation

hosting_idintegerrequired

Id of the hosting (GET /api/v3/hostings/{hosting_id})

can_installbooleanrequired

Whether the installation can start now with POST /api/v3/hostings/{hosting_id}/ssl-certificates and the same fields

reason objectrequired

Why the installation cannot start now; null when it can. ALREADY_INSTALLED: a certificate is already installed on the destination, remove it first. CNAME_MISSING: the DNS of the domain are not on our nameservers and the CNAME record in dns_delegation is missing. LIMIT_REACHED: too many Let's Encrypt installations on the hosting in the last days. HOSTING_NOT_ACTIVE: the activation of the hosting has not been completed yet. MAIL_NOT_SUPPORTED: the mail server of the hosting does not accept certificates. OPERATION_RUNNING: another installation or operation is running on the hosting

anyOf
HostingSslCertificateCanInstallReason

Why an SSL certificate cannot be installed on the hosting now (GET /api/v3/hostings/{hosting_id}/ssl-certificates/can-install)

Possible values: [ALREADY_INSTALLED, CNAME_MISSING, LIMIT_REACHED, HOSTING_NOT_ACTIVE, MAIL_NOT_SUPPORTED, OPERATION_RUNNING]

Example: CNAME_MISSING
messagestring | nullnullablerequired

Description of reason; null when the installation can start

dns_delegation objectrequired

CNAME record that delegates the validation of the Let's Encrypt certificate; null when installing a purchased certificate (ssl_certificate_id)

anyOf
managed_dnsbooleanrequired

Whether the DNS zone of the domain is on our nameservers: the installation creates the CNAME record by itself. When false the record must be created on the nameservers of the domain before the installation

hoststringrequired

Name of the CNAME record, in punycode

targetstring | nullnullablerequired

Target of the CNAME record; null when no delegation is required

presentboolean | nullnullablerequired

Whether the public DNS resolvers return the CNAME record with target; null when the DNS zone is on our nameservers, where it is not checked, or when no delegation is required

metarequired

Always null: only the paginated lists have a meta

Constant value: null
HostingSslCertificateCanInstallResponse
{
  "error": 0,
  "message": "string",
  "data": {
    "hosting_id": 0,
    "can_install": true,
    "reason": "CNAME_MISSING",
    "message": "string",
    "dns_delegation": {
      "managed_dns": true,
      "host": "string",
      "target": "string",
      "present": true
    }
  }
}