Case Study - Defending against DDoS attacks, improving DNS management, and enhancing web redirects

Activate Free SSL

Description

Activate Free SSL certificate for a specific DNS zone.


Parameters

Name Data Type Status Description
auth-id or sub-auth-id or sub-auth-user Integer Required Authentication parameter
auth-password String Required Authentication parameter
domain-name String Required Domain name you want to activate Free SSL for
issuer Integer Required Possible values:
  • 1 - ZeroSSL
  • 2 - Let's Encrypt

Return: Status and description.


Errors

When the authentication of API user is not correct, any API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect auth-id or auth-password."}

In case the credentials of API sub user are invalid, the following status and statusDescription will be returned:

{"status":"Failed","statusDescription":"Invalid authentication, incorrect sub-auth-id, sub-auth-user or auth-password."}

If you have entered an invalid or non-existent domain name, the following status will be returned:

{"status":"Failed","statusDescription":"Missing domain-name"}

If you try to activate a Free SSL certificate for a zone that has already an active Free SSL certificate, the following status will be returned:

{"status":"Failed","statusDescription":"This certificate is already active."}

Note: These are example errors in JSON format, if there are missing or wrong parameters, an error will be displayed again.



Example

URL JSON: https://api.cloudns.net/dns/freessl-activate.json
POST/GET: auth-id=0&auth-password=password&domain-name=example.com&issuer=1
POST/GET: sub-auth-id=0&auth-password=password&domain-name=example.com&issuer=1

URL XML: https://api.cloudns.net/dns/freessl-activate.xml
POST/GET: auth-id=0&auth-password=password&domain-name=example.com&issuer=1
POST/GET: sub-auth-id=0&auth-password=password&domain-name=example.com&issuer=1

 


Last modified: 2023-10-11
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more