Install

Install SSL certificate on the application. Updating SSL certificate is required after adding a new domain to the application.

HTTP Request:

POST https://api.serveravatar.com/organizations/{organization}/servers/{server}/applications/{application}/ssl

Parameter:

Parameters	Required	Type	Description
ssl_type	Yes	String	SSL type: automatic or custom
ssl_certificate	No	Text	SSL Certificate file contents in plain text, if ssl_type is custom
private_key	No	Text	Private Key file contents in plain text, if ssl_type is custom
chain_file	No	Text	Chain file content.
force_https	Yes	Boolean	Set true if you want to force https redirect.

Curl Request example:

curl --request POST \
  --url "https://api.serveravatar.com/organizations/5/servers/15/applications/92/ssl" \
  --header 'content-type: application/json' \
  --header 'accept: application/json' \
  --header 'Authorization: <YOUR API TOKEN>' \
  --data '{
    "ssl_type": "automatic",
    "force_https": false
  }'

Response:

SSL Install

• 200 (Ok)

{
  "message": "SSL Certificate has been successfully installed on this application!"
}

Organization Not Found

• 404 (Not Found)

{
    "message": "Organization not found!"
}

DNS Propagation Check

• 500 (Internal Server Error)

{
    "message": "Please wait while the DNS propagation is done."
}

SSL Already installed

• 500 (Internal Server Error)

{
    "message": "SSL is already installed on this application."
}

Application Not Found

• 404 (Not Found)

{
    "message":"Application not found!"
}

Server Not Found

• 404 (Not Found)

{
    "message": "Server not found!"
}

Server Error

• 500 (Internal Server Error)

{
    "message": "Something went really wrong!"
}