Skip to content

Latest commit

 

History

History
62 lines (48 loc) · 2.02 KB

README.md

File metadata and controls

62 lines (48 loc) · 2.02 KB
Raw

A Java wrapper for the DNSimple API

DNSimple let you do some very cool and useful things with domains via their REST API.

This library was created for internal use by Nimble Servers, hopefully it will be useful to others too.

Example Usage

There is currently only support for authentication with your API key, not your password.

DnsimpleContext context = new DnsimpleContext("[email protected]", "apikey");
List<Domain> domains = context.getDomains();
Domain firstDomain = domains.get(0);
List<Record> records = context.getRecords(firstDomain);
context.close();

Implemented Features

Not all of DNSimple's features are implemented, here is what we have so far:

  • Getting details about a specific domain
  • Listing all domains
  • Checking domain availability
  • Enabling/disabling auto-renewal for domains
  • Setting name servers for domains
  • Getting DNS records for a domain
  • Adding DNS records
  • Updating DNS records

Design Goals

  • Few dependencies (just GSON and Apache HttpClient).
  • Simple and easy to read code structure.
  • Thread safety.

Installation

This library is not on Maven central (yet) so must be compiled by yourself.

  1. Download and install Maven 3.
  2. Get the dnsimple-java source code, either with Git:
    • with Git: git clone git://github.com/milkmansrevenge/dnsimple-java.git
    • or from the Zip file.
  3. Compile with Maven (from within the same directory as pom.xml): mvn install
  4. In the target directory there should be two JAR files. The larger one contains all the other dependencies.
    • dnsimple-java-<version>.jar and
    • dnsimple-java-<version>-jar-with-dependencies.jar