DigitalOcean API Client in Java

Welcome to DigitalOcean API Client written in Java. Created a simple and meaningful wrapper methods for DigitalOcean RESTful APIs.

Simple and Lightweight Library for Enterprise Application or Utilities Integration

Give your support by clicking Hearts here DigitalOcean API Client in Java :)

Getting Started

DigitalOcean API Client library per version project dependencies:

• For v2: maps to branch master
  • Maven dependency

  <dependency>
    		<groupId>com.myjeeva.digitalocean</groupId>
    		<artifactId>digitalocean-api-client</artifactId>
    		<version>2.1</version>
    	</dependency>

  • Grails dependency

  compile 'com.myjeeva.digitalocean:digitalocean-api-client:2.1'

  • Groovy Grape

  @Grapes( 
  

@Grab(group='com.myjeeva.digitalocean', module='digitalocean-api-client', version='2.1') ) * Scala SBT

libraryDependencies += "com.myjeeva.digitalocean" % "digitalocean-api-client" % "2.1"

---

• For v1: maps to branch api-v1
  • Click here to see detailed information

---

Getting Help

For API documentation see:

• DigitalOcean API Client in Java

For Example usage see:

• Have a look at DigitalOceanIntegrationTest

Samples

• Creating a DigitalOcean Client in three simple ways!

// Way one, just pass on authToken
DigitalOcean apiClient = new DigitalOceanClient(authToken);

// Way two, pass on version number & authToken
DigitalOcean apiClient = new DigitalOceanClient("v2", authToken);

// Way three, pass on version number, authToken & httpClient
// Go ahead and customize httpClient attributes for requirements
CloseableHttpClient httpClient = HttpClients.createDefault();
DigitalOcean apiClient = new DigitalOceanClient("v2", authToken, httpClient);

• Let's invoke the method(s) as per need via apiClient

// Fetching all the available droplets from control panel 
Droplets droplets = apiClient.getAvailableDroplets(pageNo);

// Fetching all the available kernels for droplet
Kernels kernels = apiClient.getAvailableKernels(dropletId, pageNo);

// Create a new droplet
Droplet newDroplet = new Droplet();
newDroplet.setName("api-client-test-host");
newDroplet.setSize(new Size("512mb")); // setting size by slug value
newDroplet.setRegion(new Region("sgp1")); // setting region by slug value; sgp1 => Singapore 1 Data center
newDroplet.setImage(new Image(1601)); // setting by Image Id 1601 => centos-5-8-x64 also available in image slug value
newDroplet.setEnableBackup(Boolean.TRUE);
newDroplet.setEnableIpv6(Boolean.TRUE);
newDroplet.setEnablePrivateNetworking(Boolean.TRUE);
// Adding SSH key info
List<Key> keys = new ArrayList<Key>();
keys.add(new Key(6536653));
keys.add(new Key(6536654));
newDroplet.setKeys(keys);
// Adding Metadata API - User Data
newDroplet.setUserData(" < YAML Content > "); // Follow DigitalOcean documentation to prepare user_data value
Droplet droplet = apiClient.createDroplet(newDroplet);

// Fetch droplet information 
Droplet droplet = apiClient.getDropletInfo(dropletId);

// Fetch Available Plans/Sizes supported by DigitalOcean
Sizes sizes = apiClient.getAvailableSizes(pageNo);

// Fetch Available Regions supported by DigitalOcean
Sizes sizes = apiClient.getAvailableRegions(pageNo);

• Accessing RateLimit header values from return object. Note: This is applicable for all requests.

Droplets droplets = getAvailableDroplets(1);
RateLimit rateLimit = droplets.getRateLimit();

Actions actions = getAvailableActions(2);
RateLimit rateLimit = actions.getRateLimit();

Domain domain = getDomainInfo("myjeeva.com");
RateLimit rateLimit = domain.getRateLimit();

Droplet droplet = getDropletInfo(10000001);
RateLimit rateLimit = droplet.getRateLimit();

Reporting Issues

DigitalOcean API Client uses GitHub’s integrated issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations bellow:

• Before you log a bug, please search the issue tracker to see if someone has already reported the problem. If the issue doesn’t already exist, create a new issue.
• Please provide as much information as possible with the issue report, we like to know the version of DigitalOcean API Client that you are using.
• If you need to paste code, or include a stack trace use Markdown ``` escapes before and after your text.

Supported API's and Revision Logs

• As in v2.2-SNAPSHOT available in snapshot repo
  • Added compatibility for Android
• Released in v2.1
  • Enhancements
    • Libs version upgraded to latest
    • Less objects generation
• Released in v2.0
  • Account

  Account getAccountInfo()

  • Actions

    Actions getAvailableActions(Integer pageNo)
    Actions	getAvailableDropletActions(Integer dropletId, Integer pageNo)
    Actions	getAvailableImageActions(Integer imageId, Integer pageNo)
    Action getActionInfo(Integer actionId)

  • Droplets

    Droplets getAvailableDroplets(Integer pageNo)
    Kernels	getAvailableKernels(Integer dropletId, Integer pageNo)
    Snapshots getAvailableSnapshots(Integer dropletId, Integer pageNo)
    Backups	getAvailableBackups(Integer dropletId, Integer pageNo)
    Droplet	getDropletInfo(Integer dropletId)
    Droplet	createDroplet(Droplet droplet)
    Delete deleteDroplet(Integer dropletId)
    Droplets getDropletNeighbors(Integer dropletId, Integer pageNo)
    Neighbors getAllDropletNeighbors(Integer pageNo)
    

  • Droplet Actions

    Action powerCycleDroplet(Integer dropletId)
    Action powerOffDroplet(Integer dropletId)
    Action powerOnDroplet(Integer dropletId)
    Action rebootDroplet(Integer dropletId)
    Action rebuildDroplet(Integer dropletId, Integer imageId)
    Action renameDroplet(Integer dropletId, String name)
    Action resetDropletPassword(Integer dropletId)
    Action resizeDroplet(Integer dropletId, String size)
    Action restoreDroplet(Integer dropletId, Integer imageId)
    Action shutdownDroplet(Integer dropletId)
    Action takeDropletSnapshot(Integer dropletId)
    Action takeDropletSnapshot(Integer dropletId, String snapshotName)
    Action disableDropletBackups(Integer dropletId)
    Action enableDropletIpv6(Integer dropletId)
    Action enableDropletPrivateNetworking(Integer dropletId)
    Action changeDropletKernel(Integer dropletId, Integer kernelId)
    

  • Images

    Images getAvailableImages(Integer pageNo)
    Images getAvailableImages(Integer pageNo, ActionType type)
    Image getImageInfo(Integer imageId)
    Image getImageInfo(String slug)
    Image updateImage(Image image)
    Delete deleteImage(Integer imageId)
    Action transferImage(Integer imageId, String regionSlug)
    Action convertImage(Integer imageId)
    Images getUserImages(Integer pageNo)
    

  • Sizes

  Sizes getAvailableSizes(Integer pageNo)

  • Regions

  Regions getAvailableRegions(Integer pageNo)

  • Domains

    Domains	getAvailableDomains(Integer pageNo)
    Domain getDomainInfo(String domainName)
    Domain createDomain(Domain domain)
    Delete deleteDomain(String domainName)
    

  • Domain Records

    DomainRecords getDomainRecords(String domainName)
    DomainRecord getDomainRecordInfo(String domainName, Integer recordId)
    DomainRecord createDomainRecord(String domainName, DomainRecord domainRecord)
    DomainRecord updateDomainRecord(String domainName, Integer recordId, String name)
    Delete deleteDomainRecord(String domainName, Integer recordId)
    

  • Keys

    Keys getAvailableKeys(Integer pageNo)
    Key	getKeyInfo(Integer sshKeyId)
    Key	getKeyInfo(String fingerprint)
    Key	createKey(Key newKey)
    Key	updateKey(Integer sshKeyId, String newSshKeyName)
    Key	updateKey(String fingerprint, String newSshKeyName)
    Delete deleteKey(Integer sshKeyId)
    Delete deleteKey(String fingerprint)
    

Author

Jeevanandam M. - [email protected]

Contributing

1. Fork it
2. Create your feature branch - git checkout -b my-new-feature
3. Commit your changes - git commit -am 'Add some feature'
4. Push to the branch - git push origin my-new-feature
5. Create new Pull Request

License

The DigitalOcean API Client is released under MIT License.