dnsimple

v0.9.2

dnsimple v0.9.2 Dnsimple.Certificates

This module provides functions to interact with the SSL certificate related endpoints.

See: https://developer.dnsimple.com/v2/domains/certificates/

Summary

Functions

certificate(client, account_id, domain_id, certificate_id)

See Dnsimple.Certificates.get_certificate/4

certificate(client, account_id, domain_id, certificate_id, options)

See Dnsimple.Certificates.get_certificate/5

certificate_private_key(client, account_id, domain_id, certificate_id)

See Dnsimple.Certificates.get_certificate_private_key/4

certificate_private_key(client, account_id, domain_id, certificate_id, options)

See Dnsimple.Certificates.get_certificate_private_key/5

certificates(client, account_id, domain_id)

See Dnsimple.Certificates.list_certificates/3

certificates(client, account_id, domain_id, options)

See Dnsimple.Certificates.list_certificates/4

download_certificate(client, account_id, domain_id, certificate_id, options \\ [])

Returns the certificate

get_certificate(client, account_id, domain_id, certificate_id, options \\ [])

Returns the certificate data

get_certificate_private_key(client, account_id, domain_id, certificate_id, options \\ [])

Returns a certificate’s private key

list_certificates(client, account_id, domain_id, options \\ [])

Returns the list of certificates for the domain

Functions

certificate(client, account_id, domain_id, certificate_id)

See Dnsimple.Certificates.get_certificate/4.

certificate(client, account_id, domain_id, certificate_id, options)

Specs

certificate(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

See Dnsimple.Certificates.get_certificate/5.

certificate_private_key(client, account_id, domain_id, certificate_id)

See Dnsimple.Certificates.get_certificate_private_key/4.

certificate_private_key(client, account_id, domain_id, certificate_id, options)

Specs

certificate_private_key(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

See Dnsimple.Certificates.get_certificate_private_key/5.

certificates(client, account_id, domain_id)

See Dnsimple.Certificates.list_certificates/3.

certificates(client, account_id, domain_id, options)

Specs

certificates(Dnsimple.Client.t, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

See Dnsimple.Certificates.list_certificates/4.

download_certificate(client, account_id, domain_id, certificate_id, options \\ [])

Specs

download_certificate(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Returns the certificate.

See https://developer.dnsimple.com/v2/domains/certificates/#download

Examples

client = %Dnsimple.Client{access_token: “a1b2c3d4”} account_id = “1010” domain_id = “example.com”

Dnsimple.Certificates.download_certificate(client, account_id, domain_id)

get_certificate(client, account_id, domain_id, certificate_id, options \\ [])

Specs

get_certificate(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Returns the certificate data.

See https://developer.dnsimple.com/v2/domains/certificates/#get

Examples

client = %Dnsimple.Client{access_token: “a1b2c3d4”} account_id = “1010” domain_id = “example.com”

Dnsimple.Certificates.get_certificate(client, account_id, domain_id)

get_certificate_private_key(client, account_id, domain_id, certificate_id, options \\ [])

Specs

get_certificate_private_key(Dnsimple.Client.t, String.t | integer, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Returns a certificate’s private key.

See https://developer.dnsimple.com/v2/domains/certificates/#get-private-key

Examples

client = %Dnsimple.Client{access_token: “a1b2c3d4”} account_id = “1010” domain_id = “example.com”

Dnsimple.Certificates.get_certificate_private_key(client, account_id, domain_id)

list_certificates(client, account_id, domain_id, options \\ [])

Specs

list_certificates(Dnsimple.Client.t, String.t | integer, String.t | integer, Keyword.t) :: Dnsimple.Response.t

Returns the list of certificates for the domain.

See: https://developer.dnsimple.com/v2/domains/certificates/#list

Examples:

client = %Dnsimple.Client{access_token: “a1b2c3d4”} account_id = “1010” domain_id = “example.com”

Dnsimple.Certificates.list_certificates(client, account_id, domain_id) Dnsimple.Certificates.list_certificates(client, account_id, domain_id, page: 2, per_page: 10) Dnsimple.Certificates.list_certificates(client, account_id, domain_id, sort: “expires_on:desc”)