Package com.dnsimple.endpoints

Class Certificates

java.lang.Object

com.dnsimple.endpoints.Certificates

public class Certificates
extends Object

Provides access to the DNSimple Certificates API.

See Also:

• https://developer.dnsimple.com/v2/certificates

Constructor Summary

Constructors

Constructor	Description
Certificates(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
SimpleResponse<CertificateBundle>	downloadCertificate(Number account, String domain, Number certificateId)	Get the PEM-encoded certificate, aNumber with the root certificate and intermediate chain.
SimpleResponse<Certificate>	getCertificate(Number account, String domain, Number certificateId)	Get the details of a certificate.
SimpleResponse<CertificatePrivateKey>	getCertificatePrivateKey(Number account, String domain, Number certificateId)	Get the PEM-encoded certificate private key.
SimpleResponse<Certificate>	issueLetsencryptCertificate(Number account, String domain, Number certificatePurchaseId)	Issue a pending Let's Encrypt certificate order.
SimpleResponse<Certificate>	issueLetsencryptCertificateRenewal(Number account, String domain, Number certificateId, Number certificateRenewalId)	Issue a pending Let's Encrypt certificate renewal order.
PaginatedResponse<Certificate>	listCertificates(Number account, String domain)	List certificates for a domain in the account.
PaginatedResponse<Certificate>	listCertificates(Number account, String domain, ListOptions options)	List certificates for a domain in the account.
SimpleResponse<CertificatePurchase>	purchaseLetsencryptCertificate(Number account, String domain, CertificatePurchaseOptions options)	Purchase a Let's Encrypt certificate.
SimpleResponse<CertificateRenewal>	purchaseLetsencryptCertificateRenewal(Number account, String domain, Number certificateId, CertificateRenewalPurchaseOptions options)	Purchase a Let's Encrypt certificate renewal.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Certificates

public Certificates(HttpEndpointClient client)

Method Details

listCertificates

public PaginatedResponse<Certificate> listCertificates(Number account,
 String domain)

List certificates for a domain in the account.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The list certificates response

See Also:

• https://developer.dnsimple.com/v2/certificates/#listCertificates

listCertificates

public PaginatedResponse<Certificate> listCertificates(Number account,
 String domain,
 ListOptions options)

List certificates for a domain in the account.

Parameters:

account - The account ID

domain - The domain name or ID

options - The options for the list request

Returns:

The list certificates response

See Also:

• https://developer.dnsimple.com/v2/certificates/#listCertificates

getCertificate

public SimpleResponse<Certificate> getCertificate(Number account,
 String domain,
 Number certificateId)

Get the details of a certificate.

Parameters:

account - The account ID

domain - The domain name or ID

certificateId - The certificate ID

Returns:

The get certificate response

See Also:

• https://developer.dnsimple.com/v2/certificates/#getCertificate

downloadCertificate

public SimpleResponse<CertificateBundle> downloadCertificate(Number account,
 String domain,
 Number certificateId)

Get the PEM-encoded certificate, aNumber with the root certificate and intermediate chain.

Parameters:

account - The account ID

domain - The domain name or ID

certificateId - The certificate ID

Returns:

The download certificate response

See Also:

• https://developer.dnsimple.com/v2/certificates/#downloadCertificate

getCertificatePrivateKey

public SimpleResponse<CertificatePrivateKey> getCertificatePrivateKey(Number account,
 String domain,
 Number certificateId)

Get the PEM-encoded certificate private key.

Parameters:

account - The account ID

domain - The domain name or ID

certificateId - The certificate ID

Returns:

The get certificate private key response

See Also:

• https://developer.dnsimple.com/v2/certificates/#getCertificatePrivateKey

purchaseLetsencryptCertificate

public SimpleResponse<CertificatePurchase> purchaseLetsencryptCertificate(Number account,
 String domain,
 CertificatePurchaseOptions options)

Purchase a Let's Encrypt certificate.

This method creates a new purchase order. The order ID should be used to request the issuance of the certificate using `#purchase_letsencrypt_certificate`.

Parameters:

account - The account ID

domain - The domain name or ID

options - The options for the certificate purchase

Returns:

The Let's Encrypt purchase response

See Also:

• https://developer.dnsimple.com/v2/certificates/#purchaseLetsencryptCertificate

issueLetsencryptCertificate

public SimpleResponse<Certificate> issueLetsencryptCertificate(Number account,
 String domain,
 Number certificatePurchaseId)

Issue a pending Let's Encrypt certificate order.

Note that the issuance process is async. A successful response means the issuance request has been successfully acknowledged and queued for processing.

Parameters:

account - The account ID

domain - The domain name or ID

certificatePurchaseId - The ID of the purchase order returned by purchaseLetsencryptCertificate

Returns:

The Let's Encrypt issue response

See Also:

• https://developer.dnsimple.com/v2/certificates/#issueLetsencryptCertificate

purchaseLetsencryptCertificateRenewal

public SimpleResponse<CertificateRenewal> purchaseLetsencryptCertificateRenewal(Number account,
 String domain,
 Number certificateId,
 CertificateRenewalPurchaseOptions options)

Purchase a Let's Encrypt certificate renewal.

This method creates a new renewal order. The order ID should be used to request the issuance of the certificate using `#issue_letsencrypt_certificate_renewal`.

Parameters:

account - The account ID

domain - The domain name or ID

certificateId - The certificate ID

options - The options for the certificate renewal

Returns:

The Let's Encrypt purchase renewal response

See Also:

• https://developer.dnsimple.com/v2/certificates/#purchaseRenewalLetsencryptCertificate

issueLetsencryptCertificateRenewal

public SimpleResponse<Certificate> issueLetsencryptCertificateRenewal(Number account,
 String domain,
 Number certificateId,
 Number certificateRenewalId)

Issue a pending Let's Encrypt certificate renewal order.

Note that the issuance process is async. A successful response means the issuance request has been successfully acknowledged and queued for processing.

Parameters:

account - The account ID

domain - The domain name or ID

certificateId - The domain name or ID

certificateRenewalId - The ID of the purchase order returned by purchaseLetsencryptCertificateRenewal

Returns:

The Let's Encrypt issue response

See Also:

• https://developer.dnsimple.com/v2/certificates/#issueRenewalLetsencryptCertificate