certbot/certbot-dns-dnsimple/docs/api.rst

=================
API Documentation
=================

.. toctree::
   :glob:

   api/**
DNSimple DNS Authenticator (#4587) Implement an Authenticator which can fulfill a dns-01 challenge using the DNSimple DNS API. Applicable only for domains using DNSimple DNS. Testing Done: * `tox -e py27` * `tox -e lint` * Manual testing: * Used `certbot certonly --dns-dnsimple -d`, specifying a credentials file as a command line argument. Verified that a certificate was successfully obtained without user interaction. * Used `certbot certonly --dns-dnsimple -d`, without specifying a credentials file as a command line argument. Verified that the user was prompted and that a certificate was successfully obtained. * Used `certbot certonly -d`. Verified that the user was prompted for a credentials file after selecting dnsimple interactively and that a certificate was successfully obtained. * Used `certbot renew --force-renewal`. Verified that certificates were renewed without user interaction. * Negative testing: * Path to non-existent credentials file. * Credentials file with unsafe permissions (644). * Path to credentials file with an invalid token. * Path to credentials file without a token. * Domain name not registered to DNSimple account. 2017-05-22 20:06:04 -04:00			`=================`
			`API Documentation`
			`=================`

			`.. toctree::`
			`:glob:`

			`api/**`