Hetzner Cloud Documentation & Live Tester

API Reference Documentation

Hetzner Cloud SDK Overview

This testing center acts as an interactive client for the \Vendor\HetznerCloud\Facades\Hetzner Facade. Verify API connectivity, query raw data nodes, and generate copy-pasteable integration code segments.

Getting Started:Enter your credentials inside the left sidebar. Once credentials are set, choose a manager from the side navigation and run the inline test forms. Successful requests will generate copyable code for Laravel routes or jobs.

Manager Module

Servers Manager

Deploy, update, resize, power cycle, and destroy cloud virtual machine instances. Access metrics, attach private networks, and toggle backups.

List All Serversall(): Collection

servers()->all()

Retrieve all servers associated with your project.

Live Test RunnerAPI Test Box

Paginate Serverspaginate(int $perPage = 25, int $page = 1): LengthAwarePaginator

servers()->paginate()

Fetch a paginated list of servers.

Live Test RunnerAPI Test Box

Per Page

Page

Find Serverfind(int $id): ServerDTO

servers()->find()

Retrieve detailed information for a specific server ID.

Live Test RunnerAPI Test Box

Server ID *

Create Servercreate(array $data): ServerDTO

servers()->create()

Create a new cloud server instance.

Live Test RunnerAPI Test Box

Server Specifications (JSON) *

Update Serverupdate(int $id, array $data): ServerDTO

servers()->update()

Update description, name, or metadata of a server.

Live Test RunnerAPI Test Box

Server ID *

Update Parameters (JSON) *

Delete Serverdelete(int $id): bool

servers()->delete()

Permanently delete a server instance.

Live Test RunnerAPI Test Box

Server ID *

Get Metricsmetrics(int $id): MetricsDTO

servers()->metrics()

Get real-time resource usage metrics.

Live Test RunnerAPI Test Box

Server ID *

Get Action Historyactions(int $id): Collection

servers()->actions()

List background tasks triggered on the server.

Live Test RunnerAPI Test Box

Server ID *

Power OnpowerOn(int $id): ActionDTO

servers()->powerOn()

Start the server instance.

Live Test RunnerAPI Test Box

Server ID *

Power OffpowerOff(int $id): ActionDTO

servers()->powerOff()

Hard stop the server instance.

Live Test RunnerAPI Test Box

Server ID *

Graceful Shutdownshutdown(int $id): ActionDTO

servers()->shutdown()

Send an ACPI shutdown signal to guest OS.

Live Test RunnerAPI Test Box

Server ID *

Soft Rebootreboot(int $id): ActionDTO

servers()->reboot()

Request graceful OS restart.

Live Test RunnerAPI Test Box

Server ID *

Hard Resetreset(int $id): ActionDTO

servers()->reset()

Hard power cycle the server instance.

Live Test RunnerAPI Test Box

Server ID *

Rebuild OS Imagerebuild(int $id, string $image): ActionDTO

servers()->rebuild()

Wipe root disk and reinstall a clean OS image.

Live Test RunnerAPI Test Box

Server ID *

Image Name/ID *

Enable Rescue ModeenableRescue(int $id): ActionDTO

servers()->enableRescue()

Enable rescue kernel boot for repair operations.

Live Test RunnerAPI Test Box

Server ID *

Disable Rescue ModedisableRescue(int $id): ActionDTO

servers()->disableRescue()

Disable rescue kernel boot.

Live Test RunnerAPI Test Box

Server ID *

Enable Automated BackupsenableBackup(int $id): ActionDTO

servers()->enableBackup()

Turn on scheduled backup snapshots.

Live Test RunnerAPI Test Box

Server ID *

Disable Automated BackupsdisableBackup(int $id): ActionDTO

servers()->disableBackup()

Turn off scheduled backup snapshots.

Live Test RunnerAPI Test Box

Server ID *

Attach ISO ImageattachIso(int $id, string $iso): ActionDTO

servers()->attachIso()

Mount a CD-ROM virtual ISO to boot installer.

Live Test RunnerAPI Test Box

Server ID *

ISO Name/ID *

Detach ISO ImagedetachIso(int $id): ActionDTO

servers()->detachIso()

Unmount CD-ROM virtual ISO image.

Live Test RunnerAPI Test Box

Server ID *

Attach Private NetworkattachToNetwork(int $id, array $network): ActionDTO

servers()->attachToNetwork()

Attach server to private network subnet.

Live Test RunnerAPI Test Box

Server ID *

Network Configuration (JSON) *

Detach Private NetworkdetachFromNetwork(int $id, array $network): ActionDTO

servers()->detachFromNetwork()

Disconnect server from private network.

Live Test RunnerAPI Test Box

Server ID *

Network Configuration (JSON) *

Apply FirewalladdToFirewall(int $id, array $firewall): ActionDTO

servers()->addToFirewall()

Bind server interfaces to firewall filters.

Live Test RunnerAPI Test Box

Server ID *

Firewall Configuration (JSON) *

Remove FirewallremoveFromFirewall(int $id, array $firewall): ActionDTO

servers()->removeFromFirewall()

Unbind server interfaces from firewall filters.

Live Test RunnerAPI Test Box

Server ID *

Firewall Configuration (JSON) *

Manager Module

Volumes Manager

Provision and configure block storage. Resize and dynamically map attachments.

List All Volumesall(): Collection

volumes()->all()

Retrieve all provisioned block volumes.

Live Test RunnerAPI Test Box

Find Volumefind(int $id): VolumeDTO

volumes()->find()

Get metadata for a specific block volume ID.

Live Test RunnerAPI Test Box

Volume ID *

Create Volumecreate(array $data): VolumeDTO

volumes()->create()

Provision a new block storage volume.

Live Test RunnerAPI Test Box

Volume Specifications (JSON) *

Update Volumeupdate(int $id, array $data): VolumeDTO

volumes()->update()

Update name or labels of a volume.

Live Test RunnerAPI Test Box

Volume ID *

Update Parameters (JSON) *

Delete Volumedelete(int $id): bool

volumes()->delete()

Delete a volume instance.

Live Test RunnerAPI Test Box

Volume ID *

Attach Volumeattach(int $volume, int $server): ActionDTO

volumes()->attach()

Attach volume disk to a cloud server.

Live Test RunnerAPI Test Box

Volume ID *

Server ID *

Detach Volumedetach(int $volume): ActionDTO

volumes()->detach()

Safely detach volume disk from VM.

Live Test RunnerAPI Test Box

Volume ID *

Resize Volumeresize(int $volume, int $size): ActionDTO

volumes()->resize()

Increase disk partition sizes.

Live Test RunnerAPI Test Box

Volume ID *

New Size (GB) *

Manager Module

Networks Manager

Provision private SDN network infrastructures, add routes, subnets, and configure gateways.

List Networksall(): Collection

networks()->all()

List all configured private networks.

Live Test RunnerAPI Test Box

Find Networkfind(int $id): NetworkDTO

networks()->find()

Query details for a network segment ID.

Live Test RunnerAPI Test Box

Network ID *

Create Networkcreate(array $data): NetworkDTO

networks()->create()

Create private virtual network topology.

Live Test RunnerAPI Test Box

Network Configuration (JSON) *

Delete Networkdelete(int $id): bool

networks()->delete()

Delete private network topology.

Live Test RunnerAPI Test Box

Network ID *

Add Subnet RoutingaddSubnet(int $id, array $subnet): ActionDTO

networks()->addSubnet()

Define private subnet inside IP range pool.

Live Test RunnerAPI Test Box

Network ID *

Subnet Configuration (JSON) *

Delete Subnet RoutingdeleteSubnet(int $id, array $subnet): ActionDTO

networks()->deleteSubnet()

Remove private subnet route.

Live Test RunnerAPI Test Box

Network ID *

Subnet Configuration (JSON) *

Manager Module

Firewalls Manager

Apply stateless traffic rules to protect compute instances against attacks.

List Firewallsall(): Collection

firewalls()->all()

List all created firewall configurations.

Live Test RunnerAPI Test Box

Find Firewallfind(int $id): FirewallDTO

firewalls()->find()

Query firewall rules details by ID.

Live Test RunnerAPI Test Box

Firewall ID *

Create Firewallcreate(array $data): FirewallDTO

firewalls()->create()

Create new firewall container.

Live Test RunnerAPI Test Box

Firewall Configuration (JSON) *

Delete Firewalldelete(int $id): bool

firewalls()->delete()

Delete a firewall configuration.

Live Test RunnerAPI Test Box

Firewall ID *

Apply Rules SetsetRules(int $firewall, array $rules): ActionDTO

firewalls()->setRules()

Replace traffic policies with a new set of rules.

Live Test RunnerAPI Test Box

Firewall ID *

Rules List (JSON) *

Manager Module

Floating IPs Manager

Provision failover/static elastic IP routing blocks across data centers.

List Floating IPsall(): Collection

floatingIps()->all()

List all allocated Floating IPs.

Live Test RunnerAPI Test Box

Find Floating IPfind(int $id): FloatingIpDTO

floatingIps()->find()

Get status of a Floating IP ID.

Live Test RunnerAPI Test Box

IP ID *

Allocate Floating IPcreate(array $data): FloatingIpDTO

floatingIps()->create()

Request new public routing block.

Live Test RunnerAPI Test Box

IP Specs (JSON) *

Release Floating IPdelete(int $id): bool

floatingIps()->delete()

Release the Floating IP mapping back to the pool.

Live Test RunnerAPI Test Box

IP ID *

Assign to Serverassign(int $ip, int $server): ActionDTO

floatingIps()->assign()

Route Floating IP to server instance interface.

Live Test RunnerAPI Test Box

Floating IP ID *

Server ID *

Unassign Targetunassign(int $ip): ActionDTO

floatingIps()->unassign()

Stop routing traffic of Floating IP.

Live Test RunnerAPI Test Box

Floating IP ID *

Manager Module

Primary IPs Manager

Manage default network card adapter public IPs on instances.

List Primary IPsall(): Collection

primaryIps()->all()

List all default base adapters primary IPs.

Live Test RunnerAPI Test Box

Find Primary IPfind(int $id): PrimaryIpDTO

primaryIps()->find()

Fetch network card mappings for a specific Primary IP ID.

Live Test RunnerAPI Test Box

IP ID *

Manager Module

Load Balancers

Manage Layer 4/7 proxies, routing algorithms, certificates, and metrics.

List Load Balancersall(): Collection

loadBalancers()->all()

List active Load Balancers.

Live Test RunnerAPI Test Box

Find Load Balancerfind(int $id): LoadBalancerDTO

loadBalancers()->find()

Query load balancing setups by ID.

Live Test RunnerAPI Test Box

Balancer ID *

Manager Module

SSH Keys Manager

Manage inventory of secure key components.

List SSH Keysall(): Collection

sshKeys()->all()

List uploaded public keys.

Live Test RunnerAPI Test Box

Find SSH Keyfind(int $id): SshKeyDTO

sshKeys()->find()

Query key data details by ID.

Live Test RunnerAPI Test Box

Key ID *

Upload SSH Keycreate(array $data): SshKeyDTO

sshKeys()->create()

Import public key to your project.

Live Test RunnerAPI Test Box

Key Data (JSON) *

Delete SSH Keydelete(int $id): bool

sshKeys()->delete()

Remove imported key.

Live Test RunnerAPI Test Box

Key ID *

Manager Module

Images & Snapshots

List standard and user backup snapshots.

List Base Imagesall(): Collection

images()->all()

List standard and user backup snapshots.

Live Test RunnerAPI Test Box

Find Imagefind(int $id): ImageDTO

images()->find()

Query specifications of OS template ID.

Live Test RunnerAPI Test Box

Image ID *

Manager Module

Certificates Manager

Manage TLS certificates used by proxy nodes.

List Certificatesall(): Collection

certificates()->all()

List active certificates.

Live Test RunnerAPI Test Box

Find Certificatefind(int $id): CertificateDTO

certificates()->find()

Query TLS configuration specs.

Live Test RunnerAPI Test Box

Cert ID *

Manager Module

Placement Groups

Enforce host placement restrictions for reliability or latency concerns.

List Groupsall(): Collection

placementGroups()->all()

List placement restrictions.

Live Test RunnerAPI Test Box

Find Groupfind(int $id): PlacementGroupDTO

placementGroups()->find()

Query placement rules.

Live Test RunnerAPI Test Box

Group ID *

Manager Module

Locations & Zones

List all global data center facility locations.

List Locationsall(): Collection

locations()->all()

List all global data center facility locations.

Live Test RunnerAPI Test Box

Find Locationfind(int $id): LocationDTO

locations()->find()

Find specific data center facility status by ID.

Live Test RunnerAPI Test Box

Location ID *

Manager Module

Datacenters

List server cluster facilities.

List Datacentersall(): Collection

datacenters()->all()

List server cluster facilities.

Live Test RunnerAPI Test Box

Find Datacenterfind(int $id): DatacenterDTO

datacenters()->find()

Find server cluster configuration details.

Live Test RunnerAPI Test Box

Datacenter ID *

Manager Module

ISO Images

List base installable OS CDs.

List ISO Imagesall(): Collection

isos()->all()

List base installable OS CDs.

Live Test RunnerAPI Test Box

Find ISOfind(int $id): IsoDTO

isos()->find()

Get specific installer details.

Live Test RunnerAPI Test Box

ISO ID *

Manager Module

Pricing Indices

Fetch currency conversion and regional pricing lists.

Get Product Ratesall(): PricingDTO

pricing()->all()

Fetch currency conversion and regional pricing lists.

Live Test RunnerAPI Test Box

Manager Module

Global Actions

Query global system task history.

List System Actionsall(): Collection

actions()->all()

Query global system task history.

Live Test RunnerAPI Test Box

Find System Actionfind(int $id): ActionDTO

actions()->find()

Inspect specific system action details.

Live Test RunnerAPI Test Box

Action ID *

Manager Module

Server Types

List CPU/RAM VM classes.

List Server Typesall(): Collection

serverTypes()->all()

List CPU/RAM VM classes.

Live Test RunnerAPI Test Box

Find Server Typefind(int $id): ServerTypeDTO

serverTypes()->find()

Inspect specifications of a specific model type ID.

Live Test RunnerAPI Test Box

Type ID *

Manager Module

Load Balancer Types

List proxy node capacities.

List Balancer Typesall(): Collection

loadBalancerTypes()->all()

List proxy node capacities.

Live Test RunnerAPI Test Box

Find Balancer Typefind(int $id): LoadBalancerTypeDTO

loadBalancerTypes()->find()

Inspect configuration bounds for a specific model ID.

Live Test RunnerAPI Test Box

Type ID *