Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
955 lines (661 loc) · 58.4 KB

DOCUMENTATION.md

File metadata and controls

955 lines (661 loc) · 58.4 KB

Table of contents

Class: \Exploriment\HetznerCloud\Actions

Class Actions

Visibility Function

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\ApiResponse

Class ApiResponse

Visibility Function
public __construct(mixed $body) : void
ApiResponse constructor.
public __get(mixed $name) : null
public getBody() : object
public getCurrentPage() : int
public getNextPage() : int
public hasNextPage() : bool
public hasPagination() : bool
public jsonSerialize() : mixed/object
public pagination() : object

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Datacenters

Class Datacenters

Visibility Function

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\FloatingIps

Class FloatingIps

Visibility Function
public static assign(int $id, int/string/\Exploriment\HetznerCloud\Server $server) : \Exploriment\HetznerCloud\Objects\Action
Assign a floating IP to a server
public static changeDnsPtr(int $id, string $ip, null/string $dns_ptr=null) : \Exploriment\HetznerCloud\Objects\Action
Changes the hostname that will appear when getting the hostname belonging to this Floating IP.
public static create(\Exploriment\HetznerCloud\Configs\FloatingIp $config) : \Exploriment\HetznerCloud\Objects\FloatingIp
Create a new floating IP
public static delete(int $id) : bool
Delete a floating IP. If it is currently assigned to a server it will automatically get unassigned.
public static findAction(int $resource_id, int $action_id) : \Exploriment\HetznerCloud\Objects\Action
Retrieve a specific action object for a resource
public static unassign(int $id) : \Exploriment\HetznerCloud\Objects\Action
Unassign a Floating IP, resulting in it being unreachable. You may assign it to a server again at a later time.
public static update(int $id, string $description) : \Exploriment\HetznerCloud\Objects\FloatingIp
Updates the description of a floating IP.

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\HetznerCloud

Class HetznerCloud

Visibility Function
public static getAgent() : string User agent string
public static getPricing() : object
Retrieve the pricing
public static getRateLimit() : object
public static getRoot() : string
public static getTimeout() : float
public static getToken() : string
public static setRateLimit(object $limit) : void
public static setTimeout(float $timeout) : void
public static setToken(string $token) : void

Class: \Exploriment\HetznerCloud\Http

Class Http

Visibility Function
public static client() : \GuzzleHttp\Client
public static getErrorClass(object $error) : \Exception
public static parseCode(string $code) : string
public static request(mixed $method, mixed $uri, array $json=array(), array $query=array()) : bool/\Exploriment\HetznerCloud\ApiResponse
public static reset() : void
Reset the client

Class: \Exploriment\HetznerCloud\Images

Class Images

Visibility Function
public static convert(int $id) : \Exploriment\HetznerCloud\Objects\Image
Convert a Backup image to a Snapshot Image.
public static delete(int $id) : bool
Delete an image. Only snapshot and backup types
public static update(int $id, string $description) : \Exploriment\HetznerCloud\Objects\Image
Updates the image description. Only images of type snapshot and backup can be updated.

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\ISOs

Class ISOs

Visibility Function

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\Locations

Class Locations

Visibility Function

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\Resource

Class Resource

Visibility Function
public static find(mixed $id, null/string $className=null) : mixed
Retrieve a single item of the resource
public static get(int $page=1, array $options=array()) : \Illuminate\Support\Collection
Retrieve a list of this resource
public static getCurrentPage() : mixed
public static hasNextPage() : bool
Does this resource have a next page?
public static next() : \Illuminate\Support\Collection
Retrieve next page
public static retrieve(mixed $id, mixed $className=null) : void
protected static getClassName() : string
protected static getResourceName(bool $mutate=false) : string
protected static getResourceNameSingle(bool $mutate=false) : bool/string
protected static mutateName(string $name) : null/string
protected static request(string $method, string $uri='', array $json=array(), array $query=array()) : \Exploriment\HetznerCloud\ApiResponse

Class: \Exploriment\HetznerCloud\Servers

Class Servers

Visibility Function
public static attachIso(int $id, int/string/\Exploriment\HetznerCloud\ISO $iso) : \Exploriment\HetznerCloud\Objects\Action
Attaches an ISO to a server. The Server will immediately see it as a new disk. An already attached ISO will automatically be detached before the new ISO is attached. Servers with attached ISOs have a modified boot order: They will try to boot from the ISO first before falling back to hard disk.
public static changeDnsPtr(int $id, string $ip, null/string $dns_ptr=null) : \Exploriment\HetznerCloud\Objects\Action
Changes the hostname that will appear when getting the hostname belonging to the primary IPs (ipv4 and ipv6) of this server. Floating IPs assigned to the server are not affected by this.
public static changeProtection(int $id, bool $delete, bool $rebuild) : \Exploriment\HetznerCloud\Objects\Action
Changes the protection configuration of the server.
public static changeType(int $id, int/string/\Exploriment\HetznerCloud\ServerType $server_type, bool $upgrade_disk=true) : \Exploriment\HetznerCloud\Objects\Action
Changes the type (Cores, RAM and disk sizes) of a server. Server must be powered off for this command to succeed. This copies the content of its disk, and starts it again. You can only migrate to server types with the same storage_type and equal or bigger disks. Shrinking disks is not possible as it might destroy data. If the disk gets upgraded, the server type can not be downgraded any more. If you plan to downgrade the server type, set upgrade_disk to false.
public static create(\Exploriment\HetznerCloud\Configs\Server $config) : \Exploriment\HetznerCloud\Objects\ServerCreation
Create a new server
public static createImage(int $id, string $description='', string $type='snapshot') : \Exploriment\HetznerCloud\Objects\ImageCreation
Creates an image (snapshot) from a server by copying the contents of its disks. This creates a snapshot of the current state of the disk and copies it into an image. If the server is currently running you must make sure that its disk content is consistent. Otherwise, the created image may not be readable. To make sure disk content is consistent, we recommend to shut down the server prior to creating an image. You can either create a backup image that is bound to the server and therefore will be deleted when the server is deleted, or you can create an snapshot image which is completely independent of the server it was created from and will survive server deletion. Backup images are only available when the backup option is enabled for the Server. Snapshot images are billed on a per GB basis.
public static delete(int $id) : \Exploriment\HetznerCloud\Objects\Action
Delete a server
public static detachIso(int $id) : \Exploriment\HetznerCloud\Objects\Action
Detaches an ISO from a server. In case no ISO image is attached to the server, the status of the returned action is immediately set to success.
public static disableBackups(int $id) : \Exploriment\HetznerCloud\Objects\Action
Disables the automatic backup option and deletes all existing Backups for a Server. No more additional charges for backups will be made. Caution: This immediately removes all existing backups for the server!
public static disableRescue(int $id) : \Exploriment\HetznerCloud\Objects\Action
Disables the Hetzner Rescue System for a server. This makes a server start from its disks on next reboot. Rescue Mode is automatically disabled when you first boot into it or if you do not use it for 60 minutes. Disabling rescue mode will not reboot your server — you will have to do this yourself.
public static enableBackups(int $id, string/null $backup_window=null) : \Exploriment\HetznerCloud\Objects\Action
Enables and configures the automatic daily backup option for the server. Enabling automatic backups will increase the price of the server by 20%. In return, you will get seven slots where images of type backup can be stored. Backups are automatically created daily. Passing the backup_window will select the time window for the daily backup to run. All times are in UTC. 22-02 means that the backup will be started between 10 PM and 2 AM. This will be done on a best-effort base, so Hetzner cannot guarantee the backup window will be met. If you do not provide a time window one will be randomly selected.
public static enableRescue(int $id, string $type='linux64', array $ssh_keys=array()) : \Exploriment\HetznerCloud\Objects\ActionPasswordReset
Enable the Hetzner Rescue System for this server. The next time a Server with enabled rescue mode boots it will start a special minimal Linux distribution designed for repair and reinstall. In case a server cannot boot on its own you can use this to access a server’s disks. Rescue Mode is automatically disabled when you first boot into it or if you do not use it for 60 minutes. Enabling rescue mode will not reboot your server — you will have to do this yourself.
public static findAction(int $resource_id, int $action_id) : \Exploriment\HetznerCloud\Objects\Action
Retrieve a specific action object for a resource
public static getMetrics(int $id, int/string $start, int/string $end, array $types=array(), int/null $step=null) : object
Get Metrics for specified server
public static powerOff(int $id) : \Exploriment\HetznerCloud\Objects\Action
Power off a server (force stop)
public static powerOn(mixed $id) : void
public static reboot(int $id) : \Exploriment\HetznerCloud\Objects\Action
Soft-reboot a server
public static rebuild(int $id, int/string/\Exploriment\HetznerCloud\Image $image) : \Exploriment\HetznerCloud\Objects\Action
Rebuilds a server overwriting its disk with the content of an image, thereby destroying all data on the target server. The image can either be one you have created earlier (backup or snapshot image) or it can be a completely fresh system image provided by Hetzner. Your server will automatically be powered off before the rebuild command executes.
public static rename(int $id, string $name) : \Exploriment\HetznerCloud\Objects\Server
Rename a server
public static requestConsole(int $id) : \Exploriment\HetznerCloud\Objects\ConsoleCredentials
Requests credentials for remote access via vnc over websocket to keyboard, monitor, and mouse for a server. The provided url is valid for 1 minute, after this period a new url needs to be created to connect to the server. How long the connection is open after the initial connect is not subject to this timeout.
public static reset(int $id) : \Exploriment\HetznerCloud\Objects\Action
Reset a server (force restart)
public static resetPassword(int $id) : \Exploriment\HetznerCloud\Objects\ActionPasswordReset
Reset the root password for as server
public static restart(mixed $id) : void
public static shutdown(int $id) : \Exploriment\HetznerCloud\Objects\Action
Shutdown a server
public static start(int $id) : \Exploriment\HetznerCloud\Objects\Action
Start a server (power on)
public static stop(mixed $id) : void

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\ServerTypes

Class ServerTypes

Visibility Function

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\SshKeys

Class SshKeys

Visibility Function
public static create(\Exploriment\HetznerCloud\Configs\SshKey $config) : \Exploriment\HetznerCloud\Objects\SshKey
Create a new SSH key
public static delete(int $id) : bool
Delete a SSH key
public static rename(mixed $id, mixed $name) : void
public static update(int $id, string $name) : \Exploriment\HetznerCloud\Objects\SshKey
Updates the SSH key name.

This class extends \Exploriment\HetznerCloud\Resource

Class: \Exploriment\HetznerCloud\Configs\Config (abstract)

Class Config

Visibility Function
public jsonSerialize() : array

This class implements \JsonSerializable, \Exploriment\HetznerCloud\Configs\ConfigInterface

Interface: \Exploriment\HetznerCloud\Configs\ConfigInterface

Interface ConfigInterface

Visibility Function
public toArray() : array
public verify() : bool

Class: \Exploriment\HetznerCloud\Configs\FloatingIp

Class FloatingIp

Visibility Function
public __construct(mixed $type=null) : void
FloatingIp constructor.
public getDescription() : null/string
public getHomeLocation() : null/string
public getServer() : int/null
public getType() : string
public setDescription(string $description) : void
public setHomeLocation(int/string/\Exploriment\HetznerCloud\Configs\Location $home_location) : void
public setServer(int/string/\Exploriment\HetznerCloud\Configs\Objects\Server $server) : void
public setType(int/string/\Exploriment\HetznerCloud\Configs\ServerType $type) : void
public toArray() : array
public verify() : void

This class extends \Exploriment\HetznerCloud\Configs\Config

This class implements \Exploriment\HetznerCloud\Configs\ConfigInterface, \JsonSerializable

Class: \Exploriment\HetznerCloud\Configs\Server

Class Server

Visibility Function
public __construct(mixed $name=null, mixed $server_type=null, mixed $image=null) : void
Server constructor.
public getDatacenter() : string
public getImage() : string
public getLocation() : string
public getName() : string
public getServerType() : string
public getSshKeys() : array
public getUserData() : string
public isStartAfterCreate() : bool
public setDatacenter(int/string/\Exploriment\HetznerCloud\Configs\Datacenter $datacenter) : void
public setImage(int/string/\Exploriment\HetznerCloud\Configs\Image $image) : void
public setLocation(int/string/\Exploriment\HetznerCloud\Configs\Location $location) : void
public setName(string $name) : void
public setServerType(int/string/\Exploriment\HetznerCloud\Configs\ServerType $server_type) : void
public setSshKeys(array $ssh_keys) : void
public setStartAfterCreate(bool $start_after_create) : void
public setUserData(string $user_data) : void
public toArray() : array
public verify() : void

This class extends \Exploriment\HetznerCloud\Configs\Config

This class implements \Exploriment\HetznerCloud\Configs\ConfigInterface, \JsonSerializable

Class: \Exploriment\HetznerCloud\Configs\SshKey

Class SshKey

Visibility Function
public __construct(string $name='', string $public_key='') : void
SshKey constructor.
public getName() : string
public getPublicKey() : string
public setName(string $name) : void
public setPublicKey(string $public_key) : void
public toArray() : array
public verify() : void

This class extends \Exploriment\HetznerCloud\Configs\Config

This class implements \Exploriment\HetznerCloud\Configs\ConfigInterface, \JsonSerializable

Class: \Exploriment\HetznerCloud\Exceptions\ApiForbidden

Class ApiForbidden Thrown when the API returns error code forbidden

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiInvalidInput

Class ApiInvalidInput Thrown when the API returns error code invalid_input

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiInvalidServerType

Class ApiInvalidServerType Thrown when the API returns error code invalid_server_type

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiJsonError

Class ApiJsonError Thrown when the API returns error code json_error

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiLocked

Class ApiLocked Thrown when the API returns error code locked

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiNotFound

Class ApiNotFound Thrown when the API returns error code not_found

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiPlacementError

Class ApiPlacementError Thrown when the API returns error code placement_error

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiRateLimitExceeded

Class ApiRateLimitExceeded Thrown when the API returns error code rate_limit_exceeded

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiRescueAlreadyDisabled

Class ApiRescueAlreadyDisabled Thrown when the API returns error code rescue_already_disabled

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiRescueAlreadyEnabled

Class ApiRescueAlreadyEnabled Thrown when the API returns error code rescue_already_enabled

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiResourceLimitExceeded

Class ApiResourceLimitExceeded Thrown when the API returns error code resource_limit_exceeded

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiResourceUnavailable

Class ApiResourceUnavailable Thrown when the API returns error code resource_unavailable

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiServerNotStopped

Class ApiServerNotStopped Thrown when the API returns error code server_not_stopped

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiServiceError

Class ApiServiceError Thrown when the API returns error code service_error

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiUnauthorized

Class ApiUnauthorized Thrown when the API returns error code unauthorized

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\ApiUniquenessError

Class ApiUniquenessError Thrown when the API returns error code uniqueness_error

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\InvalidInput

Class InvalidInput Thrown when input was invalid

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\MalformedResponse

Class MalformedResponse Thrown when the API returns a malformed response (invalid JSON)

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Exceptions\MethodUnavailable

Class MethodUnavailable Thrown when a method cannot be used (e.g. cannot delete a system image)

Visibility Function

This class extends \Exception

This class implements \Throwable

Class: \Exploriment\HetznerCloud\Objects\Action

Class Action

Visibility Function
public getCommand() : string
Command executed in the action
public getError() : null/object
Error message for the action if error occured, otherwise null
public getFinished() : null/string
Point in time when the action was finished (in ISO-8601 format) Only set if the action status is finished, otherwise null
public getId() : int
ID of the action
public getProgress() : int
Progress of the action in percent
public getResources() : array
Resources the action relates to
public getStarted() : string
Point in time when the action was started (in ISO-8601 format)
public getStatus() : string
Status of the action
public hasError() : bool
public isRunning() : bool
public isSuccess() : bool

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\ActionPasswordReset

Class ActionPasswordReset

Visibility Function
public getRootPassword() : string
Returns the new root password for the server if the action succeeds

This class extends \Exploriment\HetznerCloud\Objects\Action

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\BaseObject

Class Object

Visibility Function
public __construct(mixed $object) : void
Object constructor.
public __toString() : string
public jsonSerialize() : array

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\ConsoleCredentials

Class ConsoleCredentials

Visibility Function
public getAction() : \Exploriment\HetznerCloud\Objects\Action
public getPassword() : string
public getWssUrl() : string

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\Datacenter

Class Datacenter

Visibility Function
public getDescription() : string
Description of the datacenter
public getId() : int
ID of the datacenter
public getLocation() : \Exploriment\HetznerCloud\Objects\Location
Location where the datacenter resides in
public getName() : string
Unique identifier of the datacenter
public getServerTypes() : object
The server types the datacenter can handle
public isAvailable(\Exploriment\HetznerCloud\Objects\ServerType/int/string $server) : bool
Check if a server type is available
public isSupported(\Exploriment\HetznerCloud\Objects\ServerType/int/string $server) : bool
Check if a server type is supported

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\FloatingIp

Class FloatingIp

Visibility Function
public assign(int/string/\Exploriment\HetznerCloud\Objects\Server $server) : \Exploriment\HetznerCloud\Objects\Action
public changeDnsPtr(string $ip, null/string $dns_ptr=null) : \Exploriment\HetznerCloud\Objects\Action
public delete() : bool
public getDescription() : null/string
Description of the floating IP
public getDnsPtr() : array
Array of reverse DNS entries
public getHomeLocation() : \Exploriment\HetznerCloud\Objects\Location
Location of the floating IP was created in. Routing is optimized for this location.
public getId() : int
ID of the floating IP
public getIp() : string
IP address of the floating IP
public getServer() : \Exploriment\HetznerCloud\Objects\Server/null
Get server information as a Server object null if the floating IP is not assigned to a server
public getServerId() : int/null
ID of the server the floating IP is assigned to, null if not assigned
public getType() : string
Type of the floating IP (ipv4 or ipv6)
public isBlocked() : bool
Whether the IP is blocked
public isIpv4() : bool
public isIpv6() : bool
public unassign() : \Exploriment\HetznerCloud\Objects\Action
public update(string $description) : \Exploriment\HetznerCloud\Objects\FloatingIp

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\Image

Class Image

Visibility Function
public canRapidDeploy() : bool
public convert() : \Exploriment\HetznerCloud\Objects\Image
public delete() : bool
public getBoundTo() : int/null
public getBoundToServer() : \Exploriment\HetznerCloud\Objects\Server/null
Retrieve the server that the image is bound to
public getCreated() : string
public getCreatedFrom() : null/object
public getDescription() : string
public getDiskSize() : float
public getId() : int
public getImageSize() : float/null
public getName() : null/string
public getOsFlavor() : string
public getOsVersion() : null/string
public getStatus() : string
public getType() : string
public isAvailable() : bool
public isBackup() : bool
public isCreating() : bool
public isSnapshot() : bool
public isSystem() : bool
public update(string $description) : \Exploriment\HetznerCloud\Objects\Image

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\ImageCreation

Class ImageCreation

Visibility Function
public getAction() : \Exploriment\HetznerCloud\Objects\Action
public getImage() : \Exploriment\HetznerCloud\Objects\Image

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\ISO

Class ISO

Visibility Function
public getDescription() : string
Description of the ISO
public getId() : int
ID of the ISO
public getName() : null/string
Unique identifier of the ISO. Only set for public ISOs
public getType() : string
Type of ISO (public / private)
public isPrivate() : bool
public isPublic() : bool

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\Location

Class Location

Visibility Function
public getCity() : string
City the location is closest to
public getCountry() : string
ISO 3166-1 alpha-2 code of the country the location resides in
public getDescription() : string
Description of the location
public getId() : int
ID of the location
public getLatitude() : float
Latitude of the city closest to the location
public getLongitude() : float
Longitude of the city closest to the location
public getName() : string
Unique identifier of the location

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\PublicNet

Class PublicNet

Visibility Function
public __toString() : string
public getIpv4() : string
Retrieve the ipv4 address of the server
public getIpv6() : string
Retrieve the ipv6 address of the server

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\Server

Class Server

Visibility Function
public attachIso(int/string/\Exploriment\HetznerCloud\Objects\ISO $iso) : \Exploriment\HetznerCloud\Objects\Action
public changeDnsPtr(string $ip, null/string $dns_ptr=null) : \Exploriment\HetznerCloud\Objects\Action
public changeProtection(bool $delete, bool $rebuild) : \Exploriment\HetznerCloud\Objects\Action
public changeType(int/string/\Exploriment\HetznerCloud\Objects\ServerType $server_type) : \Exploriment\HetznerCloud\Objects\Action
public delete() : \Exploriment\HetznerCloud\Objects\Action
public detachIso() : \Exploriment\HetznerCloud\Objects\Action
public disableBackups() : \Exploriment\HetznerCloud\Objects\Action
public disableRescue() : \Exploriment\HetznerCloud\Objects\Action
public enableBackups(string/null $backup_window=null) : \Exploriment\HetznerCloud\Objects\Action
public enableRescue(string $type='linux64', array $ssh_keys=array()) : \Exploriment\HetznerCloud\Objects\ActionPasswordReset
public findAction(int $id) : \Exploriment\HetznerCloud\Objects\Action
public getBackupWindow() : null/string
Retrieve the backup window hours (UTC) null if backups are not enabled
public getCreated() : string
Point in time when the server was created (in ISO-8601 format)
public getDatacenter() : \Exploriment\HetznerCloud\Objects\Datacenter
Datacenter this server is located at
public getId() : int
ID of the server
public getImage() : \Exploriment\HetznerCloud\Objects\Image/null
Image this server was created from
public getIncludedTraffic() : int
Retrieve the included traffic in bytes
public getIngoingTraffic() : int/null
Retrieve the ingoing traffic in bytes
public getIso() : \Exploriment\HetznerCloud\Objects\ISO/null
ISO image that is attached to this server. Null if no ISO is attached
public getMetrics(int/string $start, int/string $end, array $types=array(), int/null $step=null) : object
public getName() : string
Name of the server (must be unique per project and a valid hostname as per RFC 1123)
public getOutgoingTraffic() : int/null
Retrieve the outgoing traffic in bytes
public getPublicNet() : \Exploriment\HetznerCloud\Objects\PublicNet
Public network information
public getRemainingTraffic() : int
Retrieve the remaining free traffic in bytes
public getServerType() : \Exploriment\HetznerCloud\Objects\ServerType
Type of server - determines how much ram, disk and cpu a server has
public getStatus() : string
Status of the server
public isDeleting() : bool
public isInitializing() : bool
public isLocked() : bool
True if server has been locked and is not available to user
public isMigrating() : bool
public isOff() : bool
public isRebuilding() : bool
public isRescueEnabled() : bool
True if rescue mode is enabled: Server will then boot into rescue system on next reboot
public isRunning() : bool
public isStarting() : bool
public isStopping() : bool
public isUnknown() : bool
public powerOff() : \Exploriment\HetznerCloud\Objects\Action
public powerOn() : void
public reboot() : \Exploriment\HetznerCloud\Objects\Action
public rebuild(int/string/\Exploriment\HetznerCloud\Objects\Image $image) : \Exploriment\HetznerCloud\Objects\Action
public rename(string $name) : \Exploriment\HetznerCloud\Objects\Server
public requestConsole() : \Exploriment\HetznerCloud\Objects\ConsoleCredentials
public reset() : \Exploriment\HetznerCloud\Objects\Action
public resetPassword() : \Exploriment\HetznerCloud\Objects\ActionPasswordReset
public restart() : void
public shutdown() : \Exploriment\HetznerCloud\Objects\Action
public start() : \Exploriment\HetznerCloud\Objects\Action
public stop() : void

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\ServerCreation

Class ServerCreation

Visibility Function
public getAction() : \Exploriment\HetznerCloud\Objects\Action
public getRootPassword() : string
public getServer() : \Exploriment\HetznerCloud\Objects\Server

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\ServerType

Class ServerType

Visibility Function
public getCores() : int
Number of CPU cores a server of this type will have
public getDescription() : string
Description of the server type
public getDisk() : float
Disk size a server of this type will have in GB
public getId() : int
ID of the server type
public getMemory() : float
Memory a server of this type will have in GB
public getName() : string
Unique identifier of the server type
public getPrices() : array
Prices in different locations
public getStorageType() : string
Type of server boot drive. Local has higher speed. Network has better availability
public isLocal() : bool
public isNetwork() : bool

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable

Class: \Exploriment\HetznerCloud\Objects\SshKey

Class SshKey

Visibility Function
public delete() : bool
public getFingerprint() : string
Fingerprint of the SSH key
public getId() : int
ID of the SSH key
public getName() : string
Unique identifier of the SSH key
public getPublicKey() : string
Public key of the SSH key
public rename(string $name) : \Exploriment\HetznerCloud\Objects\SshKey
public update(string $name) : \Exploriment\HetznerCloud\Objects\SshKey

This class extends \Exploriment\HetznerCloud\Objects\BaseObject

This class implements \JsonSerializable