Update AutoSSL metadata

This function sets values for AutoSSL's metadata keys. This allows you to replace certificates that AutoSSL did not issue and toggle other AutoSSL notifications.

Note:

We recommend that you use the WHM API 1 set_autossl_metadata_key function instead.

Information:

  • You can enter more than one key and value pair in the metadata_json JSON hash.
  • Any keys that you do not explicitly define will adopt the system's default value.
Authorizations:
query Parameters
required
object

JSON-encoded object of metadata keys and values that control AutoSSL's behavior.

Example: metadata_json={"clobber_externally_signed":1,"notify_autossl_expiry":1,"notify_autossl_expiry_coverage":1,"notify_autossl_expiry_coverage_user":1,"notify_autossl_expiry_user":1,"notify_autossl_renewal":1,"notify_autossl_renewal_coverage":1,"notify_autossl_renewal_coverage_reduced":1,"notify_autossl_renewal_coverage_reduced_user":1,"notify_autossl_renewal_coverage_user":1,"notify_autossl_renewal_uncovered_domains":1,"notify_autossl_renewal_uncovered_domains_user":1,"notify_autossl_renewal_user":1}

Responses

Response Schema: application/json
object

Request samples

whmapi1 --output=jsonpretty \
  set_autossl_metadata \
  metadata_json='{"clobber_externally_signed":"1","notify_autossl_expiry":"1","notify_autossl_expiry_coverage":"1","notify_autossl_expiry_coverage_user":"1","notify_autossl_expiry_user":"1","notify_autossl_renewal":"1","notify_autossl_renewal_coverage":"1","notify_autossl_renewal_coverage_reduced":"1","notify_autossl_renewal_coverage_reduced_user":"1","notify_autossl_renewal_coverage_user":"1","notify_autossl_renewal_uncovered_domains":"1","notify_autossl_renewal_uncovered_domains_user":"1","notify_autossl_renewal_user":"1"}'

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "set_autossl_metadata",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}