me.tomsdevsn.hetznercloud

Class HetznerCloudAPI

java.lang.Object

me.tomsdevsn.hetznercloud.HetznerCloudAPI

public class HetznerCloudAPI
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
HetznerCloudAPI(java.lang.String token) Initial method to use the API

Method Summary

Modifier and Type	Method and Description
ResponseAction	assignFloatingIP(long id, RequestAssignFloatingIP requestAssignFloatingIP) Assign a Floating IP to a server
ResponseAction	attachISO(long id, RequestAttachISO requestAttachISO) Attach an ISO to a server.
ResponseGetFloatingIP	changeDescriptionOfFloatingIP(long id, RequestDescriptionFloatingIP requestDescriptionFloatingIP) Change the description of a Floating IP.
ResponseAction	changeDNSPTR(long id, RequestChangeReverseDNS requestChangeReverseDNS) Changes the reverse DNS entry from a server.
ResponseAction	changeFloatingReverseDNS(long id, RequestChangeReverseDNS requestChangeReverseDNS) Change the reverse DNS entry for a Floating IP
ResponseServernameChange	changeServerName(long id, RequestServernameChange newServerName) Change the name of the server, in the Hetzner-Cloud Console
ResponseAction	changeServerType(long id, RequestChangeType requestChangeType) Change the type from the server
ResponseSSHKey	changeSSHKeyName(long id, RequestChangeSSHKeyName requestChangeSSHKeyName) Change the name of a SSH key
java.lang.String	convertToISO8601(java.util.Date date) Converts a Date to the ISO-8601 format
ResponseFloatingIP	createFloatingIP(RequestFloatingIP requestFloatingIP) Create a Floating IP for the project or for a Server.
ResponseCreateImage	createImage(long id, RequestCreateImage requestCreateImage) Create a image from a server
ResponseServer	createServer(RequestServer requestServer) Creates a Cloud-server
ResponseSSHKey	createSSHKey(RequestSSHKey requestSSHKey) Create a SSH key.
java.lang.String	deleteFloatingIP(long id) Delete a Floating IP.
java.lang.String	deleteImage(long id) Delete an image,
ResponseAction	deleteServer(long id) Delete a server instantly.
java.lang.String	deleteSSHKey(long id) Delete a SSH key.
ResponseAction	detachISO(long id) Detach an ISO from a server.
ResponseDisableBackup	disableBackup(long id) Disable the backups from a server
ResponseAction	disableRescue(long id) Disables the rescue mode from the server.
ResponseEnableBackup	enableBackup(long id, RequestEnableBackup requestEnableBackup) Enable the backups from a server
ResponseEnableRescue	enableRescue(long id) Enables the rescue mode from the server
ResponseEnableRescue	enableRescue(long id, RequestEnableRescue requestEnableRescue) Enables the rescue mode from the server
ResponseEnableRescue	enableRescueAndReset(long id) Enables the rescue mode from the server and reset the server
ResponseEnableRescue	enableRescueAndReset(long id, RequestEnableRescue requestEnableRescue) Enables the rescue mode from the server and reset the server
ResponseAction	getActionOfFloatingIP(long floatingIPID, long actionID) Get a Action for a server
ResponseAction	getActionOfServer(long serverID, long actionID) Get a Action for a server
ResponseActions	getActionsOfFloatingIP(long id) Get all performed Actions of a Floating IP
ResponseActions	getAllActionsOfServer(long id) Get all performed Actions for a Server
ResponseDatacenter	getDatacenter(long id) Get a Datacenter by ID
ResponseDatacenters	getDatacenter(java.lang.String name) Get a datacenter by name
ResponseDatacenters	getDatacenters() Get all available datacenters and the recommendation
ResponseGetFloatingIP	getFloatingIP(long id) Get a specific Floating IP.
ResponseFloatingIPs	getFloatingIPs() Get all Floating IP's in a object
ResponseImage	getImage(long id) Get image by ID.
ResponseImages	getImageByName(java.lang.String name) Get an image by name.
ResponseImages	getImages() Get all available ResponseImages
ResponseImages	getImages(ImageType type) Get all images by type.
ResponseISO	getISOById(long id) Get an ISO by ID
ResponseISOS	getISOS() Get all available ISO's.
ResponseLocation	getLocation(long id) Get a location;
ResponseLocations	getLocationByName(java.lang.String name) Get a Location by name.
ResponseLocations	getLocations() Get all available Locations.
ResponseMetrics	getMetrics(long id, java.lang.String metricType, java.lang.String start, java.lang.String end) Get the metrics from a server
ResponsePricing	getPricing() Get all prices from the products
ResponseGetServer	getServerById(long id) Get the server by the server-id
Servers	getServerByName(java.lang.String name) Get the server by the name
Servers	getServers() Get all of your servers in a list
ResponseServerType	getServerType(long id) Create a SSH key.
ResponseServerTypes	getServerTypeByName(java.lang.String name) Get a Server type by name.
ResponseServerTypes	getServerTypes() Get all Server types.
ResponseSSHKey	getSSHKey(long id) Get a SSH key by ID.
ResponseSSHKeys	getSSHKeyByName(java.lang.String name) Get a SSH key by name.
ResponseSSHKeys	getSSHKeys() Get all SSH keys.
ResponseAction	powerOffServer(long id) Force power off a specific server with the id
ResponseAction	powerOnServer(long id) Power on a specific server with the id
ResponseRebuildServer	rebuildServer(long id, RequestRebuildServer requestRebuildServer) Rebuild a server, with the specific image.
ResponseConsole	requestConsole(long id) Request a VNC over websocket Console
ResponseResetPassword	resetRootPassword(long id) Resets the root password from a specific server with the id
ResponseAction	resetServer(long id) Reset a specific server with the id
ResponseAction	shutdownServer(long id) Soft-shutdown a specific server with the id
ResponseAction	softRebootServer(long id) Reboot a specific server with the id
ResponseAction	unassignFloatingIP(long id) Unassign a Floating IP from a server
ResponseImage	updateImage(long id, RequestUpdateImage requestUpdateImage) Update the description or the type of a image.

Methods inherited from class java.lang.Object

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

Constructor Detail

HetznerCloudAPI

public HetznerCloudAPI(java.lang.String token)

Initial method to use the API

Parameters:

token - which you created in the Hetzner-Cloud console

Method Detail

getServers

public Servers getServers()

Get all of your servers in a list

Returns:

An object which contains all servers.

getServerByName

public Servers getServerByName(java.lang.String name)

Get the server by the name

Parameters:

name - Servername of the server

Returns:

An object which contains the server in a list

getServerById

public ResponseGetServer getServerById(long id)

Get the server by the server-id

Parameters:

id - The id of the server

Returns:

The server with the specific ID

createServer

public ResponseServer createServer(RequestServer requestServer)

Creates a Cloud-server

Parameters:

requestServer - The new server to create.

Returns:

response of the API

deleteServer

public ResponseAction deleteServer(long id)

Delete a server instantly.

Parameters:

id - Server ID of the server.

Returns:

ResponseAction object

changeServerName

public ResponseServernameChange changeServerName(long id,
                                                 RequestServernameChange newServerName)

Change the name of the server, in the Hetzner-Cloud Console

Parameters:

id - of the server

newServerName - request

Returns:

respond

requestConsole

public ResponseConsole requestConsole(long id)

Request a VNC over websocket Console

Parameters:

id - ID of the server

Returns:

ResponseConsole object

getAllActionsOfServer

public ResponseActions getAllActionsOfServer(long id)

Get all performed Actions for a Server

Parameters:

id - ID of the Server

Returns:

ResponseActions object

getActionOfServer

public ResponseAction getActionOfServer(long serverID,
                                        long actionID)

Get a Action for a server

Parameters:

serverID - ID of the Server

actionID - ID of the Action

Returns:

ResponseAction object

getActionsOfFloatingIP

public ResponseActions getActionsOfFloatingIP(long id)

Get all performed Actions of a Floating IP

Parameters:

id - ID of the FloatingIP

Returns:

ResponseActions object

getActionOfFloatingIP

public ResponseAction getActionOfFloatingIP(long floatingIPID,
                                            long actionID)

Get a Action for a server

Parameters:

floatingIPID - ID of the Floating IP

actionID - ID of the Action

Returns:

ResponseAction object

powerOnServer

public ResponseAction powerOnServer(long id)

Power on a specific server with the id

Parameters:

id - of the server

Returns:

respond

powerOffServer

public ResponseAction powerOffServer(long id)

Force power off a specific server with the id

Parameters:

id - of the server

Returns:

respond

softRebootServer

public ResponseAction softRebootServer(long id)

Reboot a specific server with the id

Parameters:

id - of the server

Returns:

respond

resetServer

public ResponseAction resetServer(long id)

Reset a specific server with the id

Parameters:

id - of the server

Returns:

respond

shutdownServer

public ResponseAction shutdownServer(long id)

Soft-shutdown a specific server with the id

Parameters:

id - of the server

Returns:

respond

resetRootPassword

public ResponseResetPassword resetRootPassword(long id)

Resets the root password from a specific server with the id

Parameters:

id - of the server

Returns:

respond

enableRescue

public ResponseEnableRescue enableRescue(long id)

Enables the rescue mode from the server

Parameters:

id - of the server

Returns:

respond

enableRescue

public ResponseEnableRescue enableRescue(long id,
                                         RequestEnableRescue requestEnableRescue)

Enables the rescue mode from the server

Parameters:

id - of the server

requestEnableRescue -

Returns:

respond

enableRescueAndReset

public ResponseEnableRescue enableRescueAndReset(long id)

Enables the rescue mode from the server and reset the server

Parameters:

id - of the server

Returns:

respond

enableRescueAndReset

public ResponseEnableRescue enableRescueAndReset(long id,
                                                 RequestEnableRescue requestEnableRescue)

Enables the rescue mode from the server and reset the server

Parameters:

id - of the server

requestEnableRescue -

Returns:

respond

disableRescue

public ResponseAction disableRescue(long id)

Disables the rescue mode from the server.

Only needed, if the server doesn't booted into the rescue mode.

Parameters:

id - of the server

Returns:

respond

rebuildServer

public ResponseRebuildServer rebuildServer(long id,
                                           RequestRebuildServer requestRebuildServer)

Rebuild a server, with the specific image.

example: ubuntu-16.04

Parameters:

id - of the server

requestRebuildServer -

Returns:

respond

changeServerType

public ResponseAction changeServerType(long id,
                                       RequestChangeType requestChangeType)
                                throws java.lang.InterruptedException

Change the type from the server

example: cx11 to cx21

Attention: It will stops the server, but it starts automatically after the upgrade

Parameters:

id - of the server

requestChangeType -

Returns:

respond

Throws:

java.lang.InterruptedException

getMetrics

public ResponseMetrics getMetrics(long id,
                                  java.lang.String metricType,
                                  java.lang.String start,
                                  java.lang.String end)

Get the metrics from a server

Parameters:

id - of the server

metricType - like cpu, disk or network (but also cpu,disk possible)

start - of the metric

end - of the metric

Returns:

respond

createImage

public ResponseCreateImage createImage(long id,
                                       RequestCreateImage requestCreateImage)

Create a image from a server

Parameters:

id - of the server

requestCreateImage -

Returns:

respond

enableBackup

public ResponseEnableBackup enableBackup(long id,
                                         RequestEnableBackup requestEnableBackup)

Enable the backups from a server

Please reminder, that will increase the price of the server by 20%

Parameters:

id - of the server

requestEnableBackup -

Returns:

respond

disableBackup

public ResponseDisableBackup disableBackup(long id)

Disable the backups from a server

Caution!: This will delete all existing backups immediately

Parameters:

id - of the server

Returns:

respond

getISOS

public ResponseISOS getISOS()

Get all available ISO's.

Returns:

respond

getISOById

public ResponseISO getISOById(long id)

Get an ISO by ID

Parameters:

id - ID of the ISO

Returns:

ResponseISO Object

attachISO

public ResponseAction attachISO(long id,
                                RequestAttachISO requestAttachISO)

Attach an ISO to a server.

To get all ISO's getISOS()

Parameters:

id - of the server

requestAttachISO - Request object

Returns:

ResponseAction object

detachISO

public ResponseAction detachISO(long id)

Detach an ISO from a server.

Parameters:

id - of the server

Returns:

respond

changeDNSPTR

public ResponseAction changeDNSPTR(long id,
                                   RequestChangeReverseDNS requestChangeReverseDNS)

Changes the reverse DNS entry from a server.

Floating IPs assigned to the server are not affected!

Parameters:

id - of the server

requestChangeReverseDNS -

Returns:

respond

getDatacenter

public ResponseDatacenter getDatacenter(long id)

Get a Datacenter by ID

Parameters:

id - of the datacenter

Returns:

respond

getDatacenters

public ResponseDatacenters getDatacenters()

Get all available datacenters and the recommendation

Returns:

respond

getDatacenter

public ResponseDatacenters getDatacenter(java.lang.String name)

Get a datacenter by name

Parameters:

name - of the datacenter

Returns:

respond

getPricing

public ResponsePricing getPricing()

Get all prices from the products

Returns:

respond

getFloatingIPs

public ResponseFloatingIPs getFloatingIPs()

Get all Floating IP's in a object

Returns:

ResponseFloatingIPs object

getFloatingIP

public ResponseGetFloatingIP getFloatingIP(long id)

Get a specific Floating IP.

Parameters:

id - ID of the Floating IP

Returns:

ResponseGetFloatingIP object

createFloatingIP

public ResponseFloatingIP createFloatingIP(RequestFloatingIP requestFloatingIP)

Create a Floating IP for the project or for a Server.

Parameters:

requestFloatingIP - Request object

Returns:

ResponseFloatingIP object

changeDescriptionOfFloatingIP

public ResponseGetFloatingIP changeDescriptionOfFloatingIP(long id,
                                                           RequestDescriptionFloatingIP requestDescriptionFloatingIP)

Change the description of a Floating IP.

Parameters:

id - ID of the Floating IP

requestDescriptionFloatingIP - Request object

Returns:

ResponseGetFloatingIP object

assignFloatingIP

public ResponseAction assignFloatingIP(long id,
                                       RequestAssignFloatingIP requestAssignFloatingIP)

Assign a Floating IP to a server

Parameters:

id - ID of the Floating IP

requestAssignFloatingIP - Request object

Returns:

ResponseAction object

unassignFloatingIP

public ResponseAction unassignFloatingIP(long id)

Unassign a Floating IP from a server

Parameters:

id - ID of the Floating IP

Returns:

ResponseAction object

changeFloatingReverseDNS

public ResponseAction changeFloatingReverseDNS(long id,
                                               RequestChangeReverseDNS requestChangeReverseDNS)

Change the reverse DNS entry for a Floating IP

Parameters:

id - ID of the Floating IP

requestChangeReverseDNS - Request object

Returns:

ResponseAction object

deleteFloatingIP

public java.lang.String deleteFloatingIP(long id)

Delete a Floating IP.

This object does not have a respond!

Parameters:

id - ID of the Floating ID

Returns:

String

getSSHKeys

public ResponseSSHKeys getSSHKeys()

Get all SSH keys.

Returns:

ResponseSSHKeys object

getSSHKey

public ResponseSSHKey getSSHKey(long id)

Get a SSH key by ID.

Parameters:

id - ID of the SSH key

Returns:

ResponseSSHKey object

getSSHKeyByName

public ResponseSSHKeys getSSHKeyByName(java.lang.String name)

Get a SSH key by name.

Parameters:

name - name of the SSH key

Returns:

ResponseSSHKeys object

createSSHKey

public ResponseSSHKey createSSHKey(RequestSSHKey requestSSHKey)

Create a SSH key.

Parameters:

requestSSHKey - Request object

Returns:

ResponseSSHKey object

changeSSHKeyName

public ResponseSSHKey changeSSHKeyName(long id,
                                       RequestChangeSSHKeyName requestChangeSSHKeyName)

Change the name of a SSH key

Parameters:

id - ID of the SSH key

requestChangeSSHKeyName - Request object

Returns:

ResponseSSHKey object

deleteSSHKey

public java.lang.String deleteSSHKey(long id)

Delete a SSH key.

This object does not have a respond!

Parameters:

id - ID of the SSH key

Returns:

String

getServerTypes

public ResponseServerTypes getServerTypes()

Get all Server types.

Returns:

ResponseServerTypes object

getServerTypeByName

public ResponseServerTypes getServerTypeByName(java.lang.String name)

Get a Server type by name.

Parameters:

name - name of the Server type

Returns:

ResponseServerTypes object

getServerType

public ResponseServerType getServerType(long id)

Create a SSH key.

Parameters:

id - ID of the Server type

Returns:

ResponseServerType object

getLocations

public ResponseLocations getLocations()

Get all available Locations.

Returns:

ResponseLocations object

getLocationByName

public ResponseLocations getLocationByName(java.lang.String name)

Get a Location by name.

Parameters:

name - Name of the location

Returns:

ResponseLocations object

getLocation

public ResponseLocation getLocation(long id)

Get a location;

Parameters:

id - ID of the location

Returns:

ResponseServerType object

getImages

public ResponseImages getImages()

Get all available ResponseImages

Returns:

respond

getImages

public ResponseImages getImages(ImageType type)

Get all images by type.

Parameters:

type - Type of the images

Returns:

ResponseImages object

getImageByName

public ResponseImages getImageByName(java.lang.String name)

Get an image by name.

Parameters:

name - Name of the image

Returns:

ResponseImages object

getImage

public ResponseImage getImage(long id)

Get image by ID.

Parameters:

id - ID of the image

Returns:

ResponseImage object

updateImage

public ResponseImage updateImage(long id,
                                 RequestUpdateImage requestUpdateImage)

Update the description or the type of a image.

Parameters:

id - ID of the image

requestUpdateImage - Request object

Returns:

ResponseImage object

deleteImage

public java.lang.String deleteImage(long id)

Delete an image,

This object does not have a respond!

Parameters:

id - ID of the image

Returns:

String

convertToISO8601

public java.lang.String convertToISO8601(java.util.Date date)

Converts a Date to the ISO-8601 format

Parameters:

date - your Date

Returns:

Date in ISO-8601 format