public interface DigitalOcean
DigitalOcean API client in Java
A simple and meaningful java methods for DigitalOcean's API. All of the RESTful that you find in DigitalOcean API's Version 2 is available via simple java methods.
Sample Code:
// Create a DigitalOcean client
DigitalOcean apiClient = new DigitalOceanClient(authToken);
or
DigitalOcean apiClient = new DigitalOceanClient("v2", authToken);
Let's invoke the appropriate method as per need
// 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);
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);
and so on... simple to use and effective!
| Modifier and Type | Method and Description |
|---|---|
Action |
changeDropletKernel(Integer dropletId,
Integer kernelId)
Method changes a OS kernel for given droplet
|
Action |
convertImage(Integer imageId)
Method allows you to convert image into snapshot
|
Domain |
createDomain(Domain domain)
Method creates a new domain name with an A record for the specified [ip_address].
|
DomainRecord |
createDomainRecord(String domainName,
DomainRecord domainRecord)
Method creates a new domain record name with an given domain record values
|
Droplet |
createDroplet(Droplet droplet)
Method allows you to create a new droplet.
|
Key |
createKey(Key newKey)
Method allows you to add a new public SSH key to your account
|
Delete |
deleteDomain(String domainName)
Method deletes the specified domain from DNS control panel
|
Delete |
deleteDomainRecord(String domainName,
Integer recordId)
Method deletes the specified domain record from domain.
|
Delete |
deleteDroplet(Integer dropletId)
Method destroys one of your droplet; this is irreversible.
|
Delete |
deleteImage(Integer imageId)
Method allows you to deletes an image.
|
Delete |
deleteKey(Integer sshKeyId)
Method will delete the SSH key from your account.
|
Delete |
deleteKey(String fingerprint)
Method will delete the SSH key from your account.
|
Action |
disableDropletBackups(Integer dropletId)
Method disables automatic backups from running to backup your droplet's data.
|
Action |
enableDropletIpv6(Integer dropletId)
Enabling IP v6 networking capability for droplet.
|
Action |
enableDropletPrivateNetworking(Integer dropletId)
Enabling private networking capability for droplet.
|
Account |
getAccountInfo()
Method returns account information for provided credentials
|
Action |
getActionInfo(Integer actionId)
To retrieve a specific action information by action ID
|
Neighbors |
getAllDropletNeighbors(Integer pageNo)
For an entire account; Method retrieves a list of any droplets that are
running on the same physical server (any other droplets that share the same physical hardware).
|
Actions |
getAvailableActions(Integer pageNo)
Method return all the action informations, regardless of categories.
|
Backups |
getAvailableBackups(Integer dropletId,
Integer pageNo)
Method returns all available snapshots for given droplet ID
|
Domains |
getAvailableDomains(Integer pageNo)
Method returns all of your available domains from DNS control panel
|
Actions |
getAvailableDropletActions(Integer dropletId,
Integer pageNo)
Method return all the action informations; specific to given Droplet Id
|
Droplets |
getAvailableDroplets(Integer pageNo)
Method returns all active droplets that are currently running in your account.
|
Actions |
getAvailableImageActions(Integer imageId,
Integer pageNo)
Method return all the action informations; specific to given Image Id
|
Images |
getAvailableImages(Integer pageNo)
Method returns all the available images that can be accessed by your OAuth Token.
|
Images |
getAvailableImages(Integer pageNo,
ActionType type)
Method returns all the available images based on
type={distribution or application} that can be accessed by your OAuth Token. |
Kernels |
getAvailableKernels(Integer dropletId,
Integer pageNo)
Method returns all available kernels for given droplet ID
|
Keys |
getAvailableKeys(Integer pageNo)
Method lists all the available public SSH keys in your account that can be added to a droplet.
|
Regions |
getAvailableRegions(Integer pageNo)
Method returns all the available regions within the DigitalOcean cloud.
|
Sizes |
getAvailableSizes(Integer pageNo)
Method returns all the available sizes that can be used to create a droplet.
|
Snapshots |
getAvailableSnapshots(Integer dropletId,
Integer pageNo)
Method returns all available snapshots for given droplet ID
|
Domain |
getDomainInfo(String domainName)
Method returns the specified domain attributes and zone file info.
|
DomainRecord |
getDomainRecordInfo(String domainName,
Integer recordId)
Method returns the specified domain record.
|
DomainRecords |
getDomainRecords(String domainName)
Method returns all of your current domain records from DNS control panel for given domain.
|
Droplet |
getDropletInfo(Integer dropletId)
Method returns complete information for given droplet ID
|
Droplets |
getDropletNeighbors(Integer dropletId,
Integer pageNo)
For an individual droplet; Method retrieves a list of droplets that are running on the same
physical server (any other droplets that share the same physical hardware).
|
Image |
getImageInfo(Integer imageId)
Method retrieves the attributes of an image.
|
Image |
getImageInfo(String slug)
Method retrieves the attributes of an image.
|
Key |
getKeyInfo(Integer sshKeyId)
Method shows a specific public SSH key information from your account that can be added to a
droplet.
|
Key |
getKeyInfo(String fingerprint)
Method shows a specific public SSH key information from your account that can be added to a
droplet.
|
Images |
getUserImages(Integer pageNo)
Method retrieves only the private images of a user
|
Action |
powerCycleDroplet(Integer dropletId)
Method allows you to power cycle a droplet.
|
Action |
powerOffDroplet(Integer dropletId)
Method allows you to poweroff a running droplet.
|
Action |
powerOnDroplet(Integer dropletId)
Method allows you to poweron a powered off droplet.
|
Action |
rebootDroplet(Integer dropletId)
Method allows you to reboot a droplet.
|
Action |
rebuildDroplet(Integer dropletId,
Integer imageId)
Method allows you to reinstall a droplet with a default image.
|
Action |
renameDroplet(Integer dropletId,
String name)
Method renames the droplet to the specified name.
|
Action |
resetDropletPassword(Integer dropletId)
Method will reset the root password for a droplet.
|
Action |
resizeDroplet(Integer dropletId,
String size)
Method allows you to resize a specific droplet to a different size.
|
Action |
restoreDroplet(Integer dropletId,
Integer imageId)
Method allows you to restore a droplet with a previous image or snapshot.
|
Action |
shutdownDroplet(Integer dropletId)
Method allows you to shutdown a running droplet.
|
Action |
takeDropletSnapshot(Integer dropletId)
Method allows you to take a snapshot of the running droplet, which can later be restored or
used to create a new droplet from the same image.
|
Action |
takeDropletSnapshot(Integer dropletId,
String snapshotName)
Method allows you to take a snapshot of the running droplet, which can later be restored or
used to create a new droplet from the same image.
|
Action |
transferImage(Integer imageId,
String regionSlug)
Method allows you to transfer an image to a specified region.
|
DomainRecord |
updateDomainRecord(String domainName,
Integer recordId,
String name)
method edits an existing domain record of the given domain.
|
Image |
updateImage(Image image)
Method updates the given details for an image.
|
Key |
updateKey(Integer sshKeyId,
String newSshKeyName)
Method allows you to modify an existing SSH key in your account.
|
Key |
updateKey(String fingerprint,
String newSshKeyName)
Method allows you to modify an existing SSH key in your account.
|
Droplets getAvailableDroplets(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationDropletsDigitalOceanExceptionRequestUnsuccessfulExceptionKernels getAvailableKernels(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - for kernel infopageNo - for paginationKernelsDigitalOceanExceptionRequestUnsuccessfulExceptionSnapshots getAvailableSnapshots(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - for snapshot infopageNo - for paginationSnapshotsDigitalOceanExceptionRequestUnsuccessfulExceptionBackups getAvailableBackups(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - for backup infopageNo - for paginationBackupsDigitalOceanExceptionRequestUnsuccessfulExceptionDroplet getDropletInfo(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletDropletDigitalOceanExceptionRequestUnsuccessfulExceptionDroplet createDroplet(Droplet droplet) throws DigitalOceanException, RequestUnsuccessfulException
Method allows you to create a new droplet. See the required parameters section below for an explanation of the variables that are needed to create a new droplet.
Note: Currently return object doesn't include 'action' information of create droplet.
Create a instance of Droplet class and populated the droplet object appropriately.
Minimum required values are -
{
"name": "example-droplet-name",
"region": "nyc1",
"size": "512mb",
"image": 3445812
}
droplet - the id of the dropletDropletDigitalOceanExceptionRequestUnsuccessfulExceptionDelete deleteDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletDeleteDigitalOceanExceptionRequestUnsuccessfulExceptionDroplets getDropletNeighbors(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletpageNo - for paginationDropletsDigitalOceanExceptionRequestUnsuccessfulExceptionNeighbors getAllDropletNeighbors(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationNeighborsDigitalOceanExceptionRequestUnsuccessfulExceptionAction rebootDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction powerCycleDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction shutdownDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction powerOffDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction powerOnDroplet(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction resetDropletPassword(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction resizeDroplet(Integer dropletId, String size) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletsize - of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction takeDropletSnapshot(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction takeDropletSnapshot(Integer dropletId, String snapshotName) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletsnapshotName - the name the snapshot to be createdActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction restoreDroplet(Integer dropletId, Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletimageId - the id of the DigitalOcean public image or your private imageActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction rebuildDroplet(Integer dropletId, Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletimageId - the id of the DigitalOcean public image or your private imageActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction disableDropletBackups(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction renameDroplet(Integer dropletId, String name) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletname - the new name of droplet to be calledActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction changeDropletKernel(Integer dropletId, Integer kernelId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletkernelId - the kernel id to be changed for dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction enableDropletIpv6(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction enableDropletPrivateNetworking(Integer dropletId) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletActionDigitalOceanExceptionRequestUnsuccessfulExceptionAccount getAccountInfo() throws DigitalOceanException, RequestUnsuccessfulException
AccountDigitalOceanExceptionRequestUnsuccessfulExceptionActions getAvailableActions(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationActionsDigitalOceanExceptionRequestUnsuccessfulExceptionAction getActionInfo(Integer actionId) throws DigitalOceanException, RequestUnsuccessfulException
actionId - the id of actionActionDigitalOceanExceptionRequestUnsuccessfulExceptionActions getAvailableDropletActions(Integer dropletId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
dropletId - the id of the dropletpageNo - for paginationActionsDigitalOceanExceptionRequestUnsuccessfulExceptionActions getAvailableImageActions(Integer imageId, Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
imageId - the id of the ImagepageNo - for paginationActionsDigitalOceanExceptionRequestUnsuccessfulExceptionImages getAvailableImages(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - of request paginationImagesDigitalOceanExceptionRequestUnsuccessfulExceptionImages getAvailableImages(Integer pageNo, ActionType type) throws DigitalOceanException, RequestUnsuccessfulException
type={distribution or application} that can be accessed by your OAuth Token.pageNo - of request paginationtype - of actionImagesDigitalOceanExceptionRequestUnsuccessfulExceptionImages getUserImages(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - of request paginationImagesDigitalOceanExceptionRequestUnsuccessfulExceptionImage getImageInfo(Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
imageId - the image Id of the droplet/snapshot/backup imagesImageDigitalOceanExceptionRequestUnsuccessfulExceptionImage getImageInfo(String slug) throws DigitalOceanException, RequestUnsuccessfulException
slug - of the public imageImageDigitalOceanExceptionRequestUnsuccessfulExceptionImage updateImage(Image image) throws DigitalOceanException, RequestUnsuccessfulException
image - object for updateImageDigitalOceanExceptionRequestUnsuccessfulExceptionDelete deleteImage(Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
imageId - of the droplet/snapshot/backup imagesDeleteDigitalOceanExceptionRequestUnsuccessfulExceptionAction transferImage(Integer imageId, String regionSlug) throws DigitalOceanException, RequestUnsuccessfulException
imageId - the Id of the droplet/snapshot/backup imagesregionSlug - is code name of the region aka DigitalOcean data centersActionDigitalOceanExceptionRequestUnsuccessfulExceptionAction convertImage(Integer imageId) throws DigitalOceanException, RequestUnsuccessfulException
imageId - the Id of the droplet/snapshot/backup imagesActionDigitalOceanExceptionRequestUnsuccessfulExceptionRegions getAvailableRegions(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationRegionsDigitalOceanExceptionRequestUnsuccessfulExceptionSizes getAvailableSizes(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationSizesDigitalOceanExceptionRequestUnsuccessfulExceptionDomains getAvailableDomains(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationDomainsDigitalOceanExceptionRequestUnsuccessfulExceptionDomain getDomainInfo(String domainName) throws DigitalOceanException, RequestUnsuccessfulException
domainName - the name of the domainDomainDigitalOceanExceptionRequestUnsuccessfulExceptionDomain createDomain(Domain domain) throws DigitalOceanException, RequestUnsuccessfulException
domain - object with name and IP address for creationDomainDigitalOceanExceptionRequestUnsuccessfulExceptionDelete deleteDomain(String domainName) throws DigitalOceanException, RequestUnsuccessfulException
domainName - the name of the domainDeleteDigitalOceanExceptionRequestUnsuccessfulExceptionDomainRecords getDomainRecords(String domainName) throws DigitalOceanException, RequestUnsuccessfulException
domainName - of the domainDomainRecordsDigitalOceanExceptionRequestUnsuccessfulExceptionDomainRecord createDomainRecord(String domainName, DomainRecord domainRecord) throws DigitalOceanException, RequestUnsuccessfulException
domainName - of the domaindomainRecord - the domain record values domain Id, record type, data, name, priority,
port, weightDomainRecordDigitalOceanExceptionRequestUnsuccessfulExceptionDomainRecord getDomainRecordInfo(String domainName, Integer recordId) throws DigitalOceanException, RequestUnsuccessfulException
domainName - of the domainrecordId - of the domainDomainRecordDigitalOceanExceptionRequestUnsuccessfulExceptionDomainRecord updateDomainRecord(String domainName, Integer recordId, String name) throws DigitalOceanException, RequestUnsuccessfulException
domainName - of the domainrecordId - of the domainname - of the domain recordDomainRecordDigitalOceanExceptionRequestUnsuccessfulExceptionDelete deleteDomainRecord(String domainName, Integer recordId) throws DigitalOceanException, RequestUnsuccessfulException
domainName - of the domainrecordId - of the domainDeleteRequestUnsuccessfulExceptionDigitalOceanExceptionKeys getAvailableKeys(Integer pageNo) throws DigitalOceanException, RequestUnsuccessfulException
pageNo - for paginationKeysDigitalOceanExceptionRequestUnsuccessfulExceptionKey getKeyInfo(Integer sshKeyId) throws DigitalOceanException, RequestUnsuccessfulException
sshKeyId - the SSH key IdKeyDigitalOceanExceptionRequestUnsuccessfulExceptionKey getKeyInfo(String fingerprint) throws DigitalOceanException, RequestUnsuccessfulException
fingerprint - the SSH key fingerprintKeyDigitalOceanExceptionRequestUnsuccessfulExceptionKey createKey(Key newKey) throws DigitalOceanException, RequestUnsuccessfulException
newKey - the Key object with sshKeyName and sshPublicKeyKeyDigitalOceanExceptionRequestUnsuccessfulExceptionKey updateKey(Integer sshKeyId, String newSshKeyName) throws DigitalOceanException, RequestUnsuccessfulException
sshKeyId - the SSH key IdnewSshKeyName - the new name to give the SSH keyKeyDigitalOceanExceptionRequestUnsuccessfulExceptionKey updateKey(String fingerprint, String newSshKeyName) throws DigitalOceanException, RequestUnsuccessfulException
fingerprint - the SSH fingerprintnewSshKeyName - the new name to give the SSH keyKeyDigitalOceanExceptionRequestUnsuccessfulExceptionDelete deleteKey(Integer sshKeyId) throws DigitalOceanException, RequestUnsuccessfulException
sshKeyId - the SSH key Id, you would like to deleteDeleteDigitalOceanExceptionRequestUnsuccessfulExceptionDelete deleteKey(String fingerprint) throws DigitalOceanException, RequestUnsuccessfulException
fingerprint - the SSH fingerprintDeleteDigitalOceanExceptionRequestUnsuccessfulException
The copyright of the pages and contents on this website is with myjeeva.com and the content is licensed under Creative Commons Attribution-Share Alike 3.0 Unported License. Libraries and code snippets on myjeeva blog has license information.