Child pages
  • WHM API 1 Functions - get_autossl_metadata
Skip to end of metadata
Go to start of metadata

Description

This function retrieves values for the currently authenticated user's AutoSSL's metadata keys.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_autossl_metadata?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_autossl_metadata?api.version=1
 Command Line
whmapi1 get_autossl_metadata 


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "command":"get_autossl_metadata",
      "version":1,
      "result":1,
      "reason":"OK"
   },
   "data":{  
      "payload":{  
         "notify_autossl_expiry":"1",
         "notify_autossl_renewal":"1",
         "notify_autossl_expiry_coverage_user":1,
         "notify_autossl_renewal_uncovered_domains":"1",
         "notify_autossl_renewal_coverage":"1",
         "notify_autossl_expiry_coverage":"1",
         "notify_autossl_renewal_coverage_reduced":"1",
         "notify_autossl_renewal_user":0,
         "clobber_externally_signed":"1",
         "notify_autossl_expiry_user":1,
         "notify_autossl_renewal_uncovered_domains_user":1,
         "notify_autossl_renewal_coverage_reduced_user":1,
         "notify_autossl_renewal_coverage_user":1
      }
   }
}
 Output (XML)
<root>
   <data>
      <payload>
         <clobber_externally_signed>1</clobber_externally_signed>
         <notify_autossl_expiry>1</notify_autossl_expiry>
         <notify_autossl_expiry_coverage>1</notify_autossl_expiry_coverage>
         <notify_autossl_expiry_coverage_user>1</notify_autossl_expiry_coverage_user>
         <notify_autossl_expiry_user>1</notify_autossl_expiry_user>
         <notify_autossl_renewal>1</notify_autossl_renewal>
         <notify_autossl_renewal_coverage>1</notify_autossl_renewal_coverage>
         <notify_autossl_renewal_coverage_reduced>1</notify_autossl_renewal_coverage_reduced>
         <notify_autossl_renewal_coverage_reduced_user>1</notify_autossl_renewal_coverage_reduced_user>
         <notify_autossl_renewal_coverage_user>1</notify_autossl_renewal_coverage_user>
         <notify_autossl_renewal_uncovered_domains>1</notify_autossl_renewal_uncovered_domains>
         <notify_autossl_renewal_uncovered_domains_user>1</notify_autossl_renewal_uncovered_domains_user>
         <notify_autossl_renewal_user>0</notify_autossl_renewal_user>
      </payload>
   </data>
   <metadata>
      <command>get_autossl_metadata</command>
      <reason>OK</reason>
      <result>1</result>
      <version>1</version>
   </metadata>
</root>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample

clobber_externally_signed

Boolean

This option will allow AutoSSL to replace certificates that none of this system’s AutoSSL modules issued.

When you enable this option, AutoSSL will install certificates that replace users’ Certificate Authority (CA) issued certificates if they are invalid or expire within three days.


  • 1 — Replace the certificate.
  • 0 — Do not replace the certificate.
1

notify_autossl_expiry

Boolean

This option will send a notification when an AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate.

Notes:

  • This can happen if all of a website’s domains fail Domain Control Validation (DCV), or if the AutoSSL provider has not issued a certificate in response to a request.
  • We added this return in cPanel & WHM version 70.
  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_expiry_coverage

Boolean

This option will send a notification if at least one currently-secured domain will lose coverage when the certificate renews.

Note:

We added this parameter in cPanel & WHM return 68.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_expiry_coverage_user

Boolean

This option will send a notification if at least one of a user's currently-secured domains will lose coverage when the certificate renews.

Note:

We added this return in cPanel & WHM version 74.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_expiry_user

Boolean

This option will send a notification when a user's AutoSSL certificate expires. This occurs when AutoSSL cannot request a new certificate for a user.

Note:

We added this return in cPanel & WHM version 74.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal

Boolean

This option will send a notification when AutoSSL successfully renews a certificate.

Note:

We added this return in cPanel & WHM version 68.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal_user

Boolean

This option will send a notification when AutoSSL successfully renews a certificate for a user.

Note:

We added this return in cPanel & WHM version 74.


  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal_coverage

Boolean

This option will send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period.

Note:

We added this return in cPanel & WHM version 68.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal_coverage_user

Boolean

This option will send a notification if a currently-secured domain fails DCV and the certificate has not reached its renewal period.

Note:

We added this return in cPanel & WHM version 74.


  • 1 — Notify.
  • 0 — Do not notify.

notify_autossl_renewal_coverage_reduced

Boolean

This option will send a notification when AutoSSL has renewed a certificate and the new certificate lacks at least one domain that the previous certificate secured.

Note:

We added this return in cPanel & WHM version 70.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal_coverage_reduced_user

Boolean

This option will send a notification when AutoSSL has renewed a certificate for a user and the new certificate lacks at least one domain that the previous certificate secured.

Note:

We added this return in cPanel & WHM version 74.


  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal_uncovered_domains

Boolean

This option will send a notification when AutoSSL has renewed a certificate and the new certificate lacks one or more of the website’s domains.

Note:

We added this return in cPanel & WHM version 70.

  • 1 — Notify.
  • 0 — Do not notify.
1

notify_autossl_renewal_uncovered_domains_user

Boolean

This option will send a notification when AutoSSL has renewed a certificate for a user and the new certificate lacks one or more of the website’s domains.

Note:

We added this return in cPanel & WHM version 74.


  • 1 — Notify.
  • 0 — Do not notify.
1