API References

Main Interface

class Client(token: str, api_endpoint: str = 'https://api.hetzner.cloud/v1', application_name: str | None = None, application_version: str | None = None, poll_interval: int = 1, timeout: float | tuple[float, float] | None = None)

Base Client for accessing the Hetzner Cloud API

actions

ActionsClient Instance

Type:

ActionsClient

certificates

CertificatesClient Instance

Type:

CertificatesClient

datacenters

DatacentersClient Instance

Type:

DatacentersClient

firewalls

FirewallsClient Instance

Type:

FirewallsClient

floating_ips

FloatingIPsClient Instance

Type:

FloatingIPsClient

images

ImagesClient Instance

Type:

ImagesClient

isos

ImagesClient Instance

Type:

IsosClient

load_balancer_types

LoadBalancerTypesClient Instance

Type:

LoadBalancerTypesClient

load_balancers

LoadBalancersClient Instance

Type:

LoadBalancersClient

locations

LocationsClient Instance

Type:

LocationsClient

networks

NetworksClient Instance

Type:

NetworksClient

placement_groups

PlacementGroupsClient Instance

Type:

PlacementGroupsClient

primary_ips

PrimaryIPsClient Instance

Type:

PrimaryIPsClient

request(method: str, url: str, tries: int = 1, **kwargs) → dict

Perform a request to the Hetzner Cloud API, wrapper around requests.request

Parameters:

• method – HTTP Method to perform the Request

• url – URL of the Endpoint

• tries – Tries of the request (used internally, should not be set by the user)

• timeout – Requests timeout in seconds

Returns:

Response

server_types

ServerTypesClient Instance

Type:

ServerTypesClient

servers

ServersClient Instance

Type:

ServersClient

ssh_keys

SSHKeysClient Instance

Type:

SSHKeysClient

volumes

VolumesClient Instance

Type:

VolumesClient

API Clients

• ActionsClient
  • ResourceActionsClient
    • ResourceActionsClient.get_all()
    • ResourceActionsClient.get_by_id()
    • ResourceActionsClient.get_list()
  • ActionsClient
    • ActionsClient.get_all()
    • ActionsClient.get_by_id()
    • ActionsClient.get_list()
  • BoundAction
    • BoundAction.model
    • BoundAction.wait_until_finished()
  • Action
    • Action.STATUS_ERROR
    • Action.STATUS_RUNNING
    • Action.STATUS_SUCCESS
• CertificateClient
  • CertificatesClient
    • CertificatesClient.actions
    • CertificatesClient.create()
    • CertificatesClient.create_managed()
    • CertificatesClient.delete()
    • CertificatesClient.get_actions()
    • CertificatesClient.get_actions_list()
    • CertificatesClient.get_all()
    • CertificatesClient.get_by_id()
    • CertificatesClient.get_by_name()
    • CertificatesClient.get_list()
    • CertificatesClient.retry_issuance()
    • CertificatesClient.update()
  • BoundCertificate
    • BoundCertificate.delete()
    • BoundCertificate.get_actions()
    • BoundCertificate.get_actions_list()
    • BoundCertificate.model
    • BoundCertificate.retry_issuance()
    • BoundCertificate.update()
  • Certificate
• DatacentersClient
  • DatacentersClient
    • DatacentersClient.get_all()
    • DatacentersClient.get_by_id()
    • DatacentersClient.get_by_name()
    • DatacentersClient.get_list()
  • BoundDatacenter
    • BoundDatacenter.model
  • Datacenter
  • DatacenterServerTypes
• FirewallsClient
  • FirewallsClient
    • FirewallsClient.actions
    • FirewallsClient.apply_to_resources()
    • FirewallsClient.create()
    • FirewallsClient.delete()
    • FirewallsClient.get_actions()
    • FirewallsClient.get_actions_list()
    • FirewallsClient.get_all()
    • FirewallsClient.get_by_id()
    • FirewallsClient.get_by_name()
    • FirewallsClient.get_list()
    • FirewallsClient.remove_from_resources()
    • FirewallsClient.set_rules()
    • FirewallsClient.update()
  • BoundFirewall
    • BoundFirewall.apply_to_resources()
    • BoundFirewall.delete()
    • BoundFirewall.get_actions()
    • BoundFirewall.get_actions_list()
    • BoundFirewall.model
    • BoundFirewall.remove_from_resources()
    • BoundFirewall.set_rules()
    • BoundFirewall.update()
  • Firewall
  • FirewallRule
    • FirewallRule.DIRECTION_IN
    • FirewallRule.DIRECTION_OUT
    • FirewallRule.PROTOCOL_ESP
    • FirewallRule.PROTOCOL_GRE
    • FirewallRule.PROTOCOL_ICMP
    • FirewallRule.PROTOCOL_TCP
    • FirewallRule.PROTOCOL_UDP
    • FirewallRule.to_payload()
  • FirewallResource
    • FirewallResource.TYPE_LABEL_SELECTOR
    • FirewallResource.TYPE_SERVER
    • FirewallResource.to_payload()
  • CreateFirewallResponse
• Floating IPsClient
  • FloatingIPsClient
    • FloatingIPsClient.actions
    • FloatingIPsClient.assign()
    • FloatingIPsClient.change_dns_ptr()
    • FloatingIPsClient.change_protection()
    • FloatingIPsClient.create()
    • FloatingIPsClient.delete()
    • FloatingIPsClient.get_actions()
    • FloatingIPsClient.get_actions_list()
    • FloatingIPsClient.get_all()
    • FloatingIPsClient.get_by_id()
    • FloatingIPsClient.get_by_name()
    • FloatingIPsClient.get_list()
    • FloatingIPsClient.unassign()
    • FloatingIPsClient.update()
  • BoundFloatingIP
    • BoundFloatingIP.assign()
    • BoundFloatingIP.change_dns_ptr()
    • BoundFloatingIP.change_protection()
    • BoundFloatingIP.delete()
    • BoundFloatingIP.get_actions()
    • BoundFloatingIP.get_actions_list()
    • BoundFloatingIP.model
    • BoundFloatingIP.unassign()
    • BoundFloatingIP.update()
  • FloatingIP
  • CreateFloatingIPResponse
• ImagesClient
  • ImagesClient
    • ImagesClient.actions
    • ImagesClient.change_protection()
    • ImagesClient.delete()
    • ImagesClient.get_actions()
    • ImagesClient.get_actions_list()
    • ImagesClient.get_all()
    • ImagesClient.get_by_id()
    • ImagesClient.get_by_name()
    • ImagesClient.get_by_name_and_architecture()
    • ImagesClient.get_list()
    • ImagesClient.update()
  • BoundImage
    • BoundImage.change_protection()
    • BoundImage.delete()
    • BoundImage.get_actions()
    • BoundImage.get_actions_list()
    • BoundImage.model
    • BoundImage.update()
  • Image
  • CreateImageResponse
• ISOsClient
  • IsosClient
    • IsosClient.get_all()
    • IsosClient.get_by_id()
    • IsosClient.get_by_name()
    • IsosClient.get_list()
  • BoundIso
    • BoundIso.model
  • Iso
    • Iso.deprecated
• LoadBalancerTypesClient
  • LoadBalancerTypesClient
    • LoadBalancerTypesClient.get_all()
    • LoadBalancerTypesClient.get_by_id()
    • LoadBalancerTypesClient.get_by_name()
    • LoadBalancerTypesClient.get_list()
  • LoadBalancerType
• LoadBalancerClient
  • LoadBalancersClient
    • LoadBalancersClient.actions
    • LoadBalancersClient.add_service()
    • LoadBalancersClient.add_target()
    • LoadBalancersClient.attach_to_network()
    • LoadBalancersClient.change_algorithm()
    • LoadBalancersClient.change_dns_ptr()
    • LoadBalancersClient.change_protection()
    • LoadBalancersClient.change_type()
    • LoadBalancersClient.create()
    • LoadBalancersClient.delete()
    • LoadBalancersClient.delete_service()
    • LoadBalancersClient.detach_from_network()
    • LoadBalancersClient.disable_public_interface()
    • LoadBalancersClient.enable_public_interface()
    • LoadBalancersClient.get_actions()
    • LoadBalancersClient.get_actions_list()
    • LoadBalancersClient.get_all()
    • LoadBalancersClient.get_by_id()
    • LoadBalancersClient.get_by_name()
    • LoadBalancersClient.get_list()
    • LoadBalancersClient.get_metrics()
    • LoadBalancersClient.remove_target()
    • LoadBalancersClient.update()
    • LoadBalancersClient.update_service()
  • BoundLoadBalancer
    • BoundLoadBalancer.add_service()
    • BoundLoadBalancer.add_target()
    • BoundLoadBalancer.attach_to_network()
    • BoundLoadBalancer.change_algorithm()
    • BoundLoadBalancer.change_dns_ptr()
    • BoundLoadBalancer.change_protection()
    • BoundLoadBalancer.change_type()
    • BoundLoadBalancer.delete()
    • BoundLoadBalancer.delete_service()
    • BoundLoadBalancer.detach_from_network()
    • BoundLoadBalancer.disable_public_interface()
    • BoundLoadBalancer.enable_public_interface()
    • BoundLoadBalancer.get_actions()
    • BoundLoadBalancer.get_actions_list()
    • BoundLoadBalancer.get_metrics()
    • BoundLoadBalancer.model
    • BoundLoadBalancer.remove_target()
    • BoundLoadBalancer.update()
    • BoundLoadBalancer.update_service()
  • LoadBalancer
  • LoadBalancerService
    • LoadBalancerService.to_payload()
  • LoadBalancerServiceHttp
  • LoadBalancerHealthCheck
  • LoadBalancerHealtCheckHttp
  • LoadBalancerTarget
    • LoadBalancerTarget.to_payload()
  • LoadBalancerTargetHealthStatus
  • LoadBalancerTargetLabelSelector
  • LoadBalancerTargetIP
  • LoadBalancerAlgorithm
• LocationsClient
  • LocationsClient
    • LocationsClient.get_all()
    • LocationsClient.get_by_id()
    • LocationsClient.get_by_name()
    • LocationsClient.get_list()
  • BoundLocation
    • BoundLocation.model
  • Location
• NetworksClient
  • NetworksClient
    • NetworksClient.actions
    • NetworksClient.add_route()
    • NetworksClient.add_subnet()
    • NetworksClient.change_ip_range()
    • NetworksClient.change_protection()
    • NetworksClient.create()
    • NetworksClient.delete()
    • NetworksClient.delete_route()
    • NetworksClient.delete_subnet()
    • NetworksClient.get_actions()
    • NetworksClient.get_actions_list()
    • NetworksClient.get_all()
    • NetworksClient.get_by_id()
    • NetworksClient.get_by_name()
    • NetworksClient.get_list()
    • NetworksClient.update()
  • BoundNetwork
    • BoundNetwork.add_route()
    • BoundNetwork.add_subnet()
    • BoundNetwork.change_ip_range()
    • BoundNetwork.change_protection()
    • BoundNetwork.delete()
    • BoundNetwork.delete_route()
    • BoundNetwork.delete_subnet()
    • BoundNetwork.get_actions()
    • BoundNetwork.get_actions_list()
    • BoundNetwork.model
    • BoundNetwork.update()
  • Network
  • NetworkSubnet
    • NetworkSubnet.TYPE_CLOUD
    • NetworkSubnet.TYPE_SERVER
    • NetworkSubnet.TYPE_VSWITCH
  • NetworkRoute
  • CreateNetworkResponse
• PlacementGroupsClient
  • PlacementGroupsClient
    • PlacementGroupsClient.create()
    • PlacementGroupsClient.delete()
    • PlacementGroupsClient.get_all()
    • PlacementGroupsClient.get_by_id()
    • PlacementGroupsClient.get_by_name()
    • PlacementGroupsClient.get_list()
    • PlacementGroupsClient.update()
  • BoundPlacementGroup
    • BoundPlacementGroup.delete()
    • BoundPlacementGroup.model
    • BoundPlacementGroup.update()
  • PlacementGroup
  • CreatePlacementGroupResponse
• PrimaryIPsClient
  • PrimaryIPsClient
    • PrimaryIPsClient.actions
    • PrimaryIPsClient.assign()
    • PrimaryIPsClient.change_dns_ptr()
    • PrimaryIPsClient.change_protection()
    • PrimaryIPsClient.create()
    • PrimaryIPsClient.delete()
    • PrimaryIPsClient.get_all()
    • PrimaryIPsClient.get_by_id()
    • PrimaryIPsClient.get_by_name()
    • PrimaryIPsClient.get_list()
    • PrimaryIPsClient.unassign()
    • PrimaryIPsClient.update()
  • BoundPrimaryIP
    • BoundPrimaryIP.assign()
    • BoundPrimaryIP.change_dns_ptr()
    • BoundPrimaryIP.change_protection()
    • BoundPrimaryIP.delete()
    • BoundPrimaryIP.model
    • BoundPrimaryIP.unassign()
    • BoundPrimaryIP.update()
  • PrimaryIP
• ServerTypesClient
  • ServerTypesClient
    • ServerTypesClient.get_all()
    • ServerTypesClient.get_by_id()
    • ServerTypesClient.get_by_name()
    • ServerTypesClient.get_list()
  • BoundServerType
    • BoundServerType.model
  • ServerType
• ServersClient
  • ServersClient
    • ServersClient.actions
    • ServersClient.add_to_placement_group()
    • ServersClient.attach_iso()
    • ServersClient.attach_to_network()
    • ServersClient.change_alias_ips()
    • ServersClient.change_dns_ptr()
    • ServersClient.change_protection()
    • ServersClient.change_type()
    • ServersClient.create()
    • ServersClient.create_image()
    • ServersClient.delete()
    • ServersClient.detach_from_network()
    • ServersClient.detach_iso()
    • ServersClient.disable_backup()
    • ServersClient.disable_rescue()
    • ServersClient.enable_backup()
    • ServersClient.enable_rescue()
    • ServersClient.get_actions()
    • ServersClient.get_actions_list()
    • ServersClient.get_all()
    • ServersClient.get_by_id()
    • ServersClient.get_by_name()
    • ServersClient.get_list()
    • ServersClient.get_metrics()
    • ServersClient.power_off()
    • ServersClient.power_on()
    • ServersClient.reboot()
    • ServersClient.rebuild()
    • ServersClient.remove_from_placement_group()
    • ServersClient.request_console()
    • ServersClient.reset()
    • ServersClient.reset_password()
    • ServersClient.shutdown()
    • ServersClient.update()
  • BoundServer
    • BoundServer.add_to_placement_group()
    • BoundServer.attach_iso()
    • BoundServer.attach_to_network()
    • BoundServer.change_alias_ips()
    • BoundServer.change_dns_ptr()
    • BoundServer.change_protection()
    • BoundServer.change_type()
    • BoundServer.create_image()
    • BoundServer.delete()
    • BoundServer.detach_from_network()
    • BoundServer.detach_iso()
    • BoundServer.disable_backup()
    • BoundServer.disable_rescue()
    • BoundServer.enable_backup()
    • BoundServer.enable_rescue()
    • BoundServer.get_actions()
    • BoundServer.get_actions_list()
    • BoundServer.get_metrics()
    • BoundServer.model
    • BoundServer.power_off()
    • BoundServer.power_on()
    • BoundServer.reboot()
    • BoundServer.rebuild()
    • BoundServer.remove_from_placement_group()
    • BoundServer.request_console()
    • BoundServer.reset()
    • BoundServer.reset_password()
    • BoundServer.shutdown()
    • BoundServer.update()
  • Server
    • Server.STATUS_DELETING
    • Server.STATUS_INIT
    • Server.STATUS_MIGRATING
    • Server.STATUS_OFF
    • Server.STATUS_REBUILDING
    • Server.STATUS_RUNNING
    • Server.STATUS_STARTING
    • Server.STATUS_STOPPING
    • Server.STATUS_UNKNOWN
  • PublicNetwork
  • IPv4Address
  • IPv6Network
  • CreateServerResponse
  • ServerCreatePublicNetwork
  • ResetPasswordResponse
  • EnableRescueResponse
  • RequestConsoleResponse
• SSHKeysClient
  • SSHKeysClient
    • SSHKeysClient.create()
    • SSHKeysClient.delete()
    • SSHKeysClient.get_all()
    • SSHKeysClient.get_by_fingerprint()
    • SSHKeysClient.get_by_id()
    • SSHKeysClient.get_by_name()
    • SSHKeysClient.get_list()
    • SSHKeysClient.update()
  • BoundSSHKey
    • BoundSSHKey.delete()
    • BoundSSHKey.model
    • BoundSSHKey.update()
  • SSHKey
• VolumesClient
  • VolumesClient
    • VolumesClient.actions
    • VolumesClient.attach()
    • VolumesClient.change_protection()
    • VolumesClient.create()
    • VolumesClient.delete()
    • VolumesClient.detach()
    • VolumesClient.get_actions()
    • VolumesClient.get_actions_list()
    • VolumesClient.get_all()
    • VolumesClient.get_by_id()
    • VolumesClient.get_by_name()
    • VolumesClient.get_list()
    • VolumesClient.resize()
    • VolumesClient.update()
  • BoundVolume
    • BoundVolume.attach()
    • BoundVolume.change_protection()
    • BoundVolume.delete()
    • BoundVolume.detach()
    • BoundVolume.get_actions()
    • BoundVolume.get_actions_list()
    • BoundVolume.model
    • BoundVolume.resize()
    • BoundVolume.update()
  • Volume
    • Volume.STATUS_AVAILABLE
    • Volume.STATUS_CREATING
  • CreateVolumeResponse

Exceptions

class HCloudException

There was an error while using the hcloud library

class APIException(code: int | str, message: str | None, details: Any)

There was an error while performing an API Request

class ActionException(action: Action | BoundAction)

A generic action exception

class ActionFailedException(action: Action | BoundAction)

The pending action failed

class ActionTimeoutException(action: Action | BoundAction)

The pending action timed out

Other

• Helpers
  • LabelValidator
    • LabelValidator.validate()
    • LabelValidator.validate_verbose()
• Deprecation Info
  • DeprecationInfo