Changelog

v2.22.0

Datacenters resource is now deprecated

The endpoints GET /v1/datacenters and GET /v1/datacenters/{id} are now deprecated and will be removed after 1 Oct. 2026. After this date, requests to these endpoints will return HTTP 410 Gone.

The DatacentersClient, Datacenter and related classes are now deprecated.

See the changelog for more details.

Features

  • deprecate datacenters (#656)

v2.21.0

Features

  • retry requests on api bad_gateway error (#658)

v2.20.0

Load Balancer HTTP Services now support timeout_idle

HTTP Services now support the field timeout_idle, which controls the time a HTTP connection is allowed to idle before it is being dropped.

See the changelog for more information.

Features

  • load-balancer: support timeout_idle http service field (#649)

v2.19.0

Primary IPs assignee_type behavior change

In the create Primary IP call, the assignee_type argument is now only send when the assignee_id argument is set. The assignee_type argument will stop defaulting to server in the near future, consider explicitly setting this argument when needed.

As of 1 August 2026, the behavior of the Primary IP assignee_type property will change, and will return unassigned when the Primary IP is not assigned (when assignee_id is null). The goal is to eventually assign Primary IPs to other resource types, not only to server.

See the changelog for more details.

In addition, the Primary IP request body assignee_type property of the operation POST /v1/primary_ips is now optional. Primary IPs created without assignee_type return server until 1 August 2026, after this date, its value will be unassigned.

See the changelog for more details.

Features

  • primary-ip: assignee_type behavior changed when creating a primary ip (#647)

v2.18.0

Features

  • datacenter, server_type: move available and recommended to server_type (#645)

v2.17.1

Bug Fixes

  • missing __api_properties__ on LoadBalancerService (#639)

v2.17.0

Features

  • parse nested load balancer label_selector targets (#633)

v2.16.0

Storage Boxes support is now generally available

The experimental phase for Storage Boxes is over, and Storage Boxes support is now generally available.

Features

  • servers: allow setting user_data for rebuild (#627)

  • Storage Box support no longer experimental (#626)

v2.15.0

Features

  • add name to Storage Box Subaccount (#621)

v2.14.0

Features

  • retry requests when the api returns a timeout error (#617)

v2.13.0

Features

  • add per primary ip actions list operations (#608)

  • deprecate datacenter in primary ips and servers (#609)

v2.12.0

Storage Box API Experimental

This release adds support for the Storage Box API.

The Storage Box integration will be introduced as an experimental feature. This experimental phase is expected to last at least until 12 January 2026. During this period, upcoming minor releases of the project may include breaking changes to features related to Storage Boxes.

This release includes all changes from the recent Storage Box API changelog entry.

Examples

response = client.storage_boxes.create(
    name="string",
    location=Location(name="fsn1"),
    storage_box_type=StorageBoxType(name="bx11"),
    labels={
        "environment": "prod",
        "example.com/my": "label",
        "just-a-key": "",
    },
    password="my-password",
    access_settings=StorageBoxAccessSettings(
        reachable_externally=False,
        samba_enabled=False,
        ssh_enabled=False,
        webdav_enabled=False,
        zfs_enabled=False,
    ),
    ssh_keys=[SSHKey(public_key="ssh-rsa AAAjjk76kgf...Xt")],
)

response.action.wait_until_finished()

storage_box = response.storage_box

Features

  • add update rrset records action to zone client (#597)

  • add support for Storage Boxes (#524)

v2.11.1

Bug Fixes

  • support reloading sub resource bound models (#590)

v2.11.0

DNS API is now generally available

The DNS API is now generally available, as well as support for features in this project that are related to the DNS API.

To migrate existing zones to the new DNS API, see the DNS migration guide.

See the changelog for more details.

Features

  • DNS support is now generally available (#581)

v2.10.0

Features

  • exp: add zone format txt record helper (#578)

  • add server and load balancer private_net_for helper method (#580)

v2.9.0

Features

  • support python 3.14 (#566)

  • drop support for python 3.9 (#574)

v2.8.0

DNS API Beta

This release adds support for the new DNS API.

The DNS API is currently in beta, which will likely end on 10 November 2025. After the beta ended, it will no longer be possible to create new zones in the old DNS system. See the DNS Beta FAQ for more details.

Future minor releases of this project may include breaking changes for features that are related to the DNS API.

See the DNS API Beta changelog for more details.

Examples

resp = client.zones.create(
    name="example.com",
    mode="primary",
    labels={"key": "value"},
    rrsets=[
        ZoneRRSet(
            name="@",
            type="A",
            records=[
                ZoneRecord(value="201.180.75.2", comment="server1")
            ],
        )
    ],
)

resp.action.wait_until_finished()
zone = resp.zone

Features

  • add new ip_range param to load balancer attach_to_network (#562)

  • add new ip_range param to server attach_to_network (#561)

  • support the new DNS API (#568)

Bug Fixes

  • source_ips property is optional in firewall rule (#567)

v2.7.0

Server Types now depend on Locations.

  • We added a new locations property to the Server Types resource. The new property defines a list of supported Locations and additional per Locations details such as deprecations information.

  • We deprecated the deprecation property from the Server Types resource. The property will gradually be phased out as per Locations deprecations are being announced. Please use the new per Locations deprecation information instead.

See our changelog for more details.

Upgrading

# Before
def validate_server_type(server_type: ServerType):
    if server_type.deprecation is not None:
        raise ValueError(f"server type {server_type.name} is deprecated")

# After
def validate_server_type(server_type: ServerType, location: Location):
    found = [o for o in server_type.locations if location.name == o.location.name]
    if not found:
        raise ValueError(
            f"server type {server_type.name} is not supported in location {location.name}"
        )

    server_type_location = found[0]

    if server_type_location.deprecation is not None:
        raise ValueError(
            f"server type {server_type.name} is deprecated in location {location.name}"
        )

Features

  • per location server types (#558)

v2.6.0

Features

  • add category property to server type (#549)

Bug Fixes

  • rename ClientEntityBase to ResourceClientBase (#532)

v2.5.4

Bug Fixes

  • typo in LoadBalancerHealthCheckHttp class name (#511)

  • equality for some domain classes (#510)

  • use valid license identifier (SPDX) (#514)

v2.5.3

Bug Fixes

  • invalid placement group id casting (#501)

  • handle string id when checking has_id_or_name (#504)

v2.5.2

Bug Fixes

  • listing page result always provide meta (#496)

v2.5.1

Bug Fixes

  • missing slots and api_properties for FirewallResourceLabelSelector (#492)

v2.5.0

Features

  • improve exception messages (#488)

v2.4.0

Features

  • drop support for python 3.8 (#458)

  • add equality checks to domains (#481)

Bug Fixes

  • server public ipv4 and ipv6 properties are nullable (#455)

2.3.0 (2024-10-09)

Features

Bug Fixes

  • change floating ip labels type to dict[str, str] (#444) (1f6da4e)

2.2.1 (2024-08-19)

Bug Fixes

2.2.0 (2024-08-06)

Features

  • retry requests when the api gateway errors (#430) (f63ac8b)

  • retry requests when the api returns a conflict error (#430) (f63ac8b)

  • retry requests when the network timed outs (#430) (f63ac8b)

  • retry requests when the rate limit was reached (#430) (f63ac8b)

Bug Fixes

2.1.1 (2024-07-30)

Bug Fixes

  • do not sleep before checking for the reloaded action status (#426) (3e0a85b)

  • mark client retry backoff function as static (#429) (14ed130)

Documentation

2.1.0 (2024-07-25)

API Changes for Traffic Prices and Server Type Included Traffic

There will be a breaking change in the API regarding Traffic Prices and Server Type Included Traffic on 2024-08-05. This release marks the affected fields as Deprecated. Please check if this affects any of your code and switch to the replacement fields where necessary.

You can learn more about this change in our changelog.

Features

  • add exponential and constant backoff function (#416) (fe7ddf6)

  • deprecate ServerType included_traffic property (#423) (3d56ac5)

  • use exponential backoff when retrying requests (#417) (f306073)

2.0.1 (2024-07-03)

Bug Fixes

  • assignee_type is required when creating a primary ip (#409) (bce5e94)

  • clean unused arguments in the Client.servers.rebuild method (#407) (6d33c3c)

  • details are optional in API errors (#411) (f1c6594)

  • rename trace_id variable to correlation_id (#408) (66a0f54)

2.0.0 (2024-07-03)

⚠ BREAKING CHANGES

  • return full rebuild response in Client.servers.rebuild (#406)

  • make datacenter argument optional when creating a primary ip (#363)

  • remove deprecated include_wildcard_architecture argument in IsosClient.get_list and IsosClient.get_all (#402)

  • make Client.request tries a private argument (#399)

  • make Client.poll_interval a private property (#398)

  • return empty dict on empty responses in Client.request (#400)

  • remove deprecated hcloud.hcloud module (#401)

  • move hcloud.__version__.VERSION to hcloud.__version__ (#397)

Features

  • add trace_id to API exceptions (#404) (8375261)

  • allow using a custom poll_interval function (#403) (93eb56b)

  • make Client.poll_interval a private property (#398) (d5f24db)

  • make Client.request tries a private argument (#399) (428ea7e)

  • move hcloud.__version__.VERSION to hcloud.__version__ (#397) (4e3f638), closes #234

  • remove deprecated hcloud.hcloud module (#401) (db37e63)

  • remove deprecated include_wildcard_architecture argument in IsosClient.get_list and IsosClient.get_all (#402) (6b977e2)

  • return empty dict on empty responses in Client.request (#400) (9f46adb)

  • return full rebuild response in Client.servers.rebuild (#406) (1970d84)

Bug Fixes

  • make datacenter argument optional when creating a primary ip (#363) (ebef774)

Dependencies

  • update dependency coverage to >=7.5,<7.6 (#386) (5660691)

  • update dependency mypy to >=1.10,<1.11 (#387) (35c933b)

  • update dependency myst-parser to v3 (#385) (9f18270)

  • update dependency pylint to >=3,<3.3 (#391) (4a6f005)

  • update dependency pytest to >=8,<8.3 (#390) (584a36b)

  • update dependency sphinx to >=7.3.4,<7.4 (#383) (69c2e16)

  • update pre-commit hook asottile/pyupgrade to v3.16.0 (0ce5fbc)

  • update pre-commit hook pre-commit/pre-commit-hooks to v4.6.0 (5ef25ab)

  • update pre-commit hook psf/black-pre-commit-mirror to v24.4.0 (0941fbf)

  • update pre-commit hook psf/black-pre-commit-mirror to v24.4.1 (fec08c5)

  • update pre-commit hook psf/black-pre-commit-mirror to v24.4.2 (#389) (2b2e21f)

  • update pre-commit hook pycqa/flake8 to v7.1.0 (3bc651d)

Documentation

1.35.0 (2024-04-02)

Features

  • add include_deprecated option when fetching images by name (#375) (6d86f86)

Bug Fixes

  • raise warnings for the ImagesClient.get_by_name deprecation (#376) (b24de80)

1.34.0 (2024-03-27)

Features

  • add has_id_or_name to DomainIdentityMixin (#373) (8facaf6)

1.33.3 (2024-03-27)

Bug Fixes

  • invalid type for load balancer private network property (#372) (903e92f)

Dependencies

  • update codecov/codecov-action action to v4 (#359) (a798979)

  • update dependency mypy to >=1.9,<1.10 (#368) (4b9328c)

  • update dependency pylint to >=3,<3.2 (#364) (d71d17f)

  • update dependency pytest to >=8,<8.2 (#366) (8665dcf)

  • update dependency pytest to v8 (#357) (f8f756f)

  • update dependency pytest-cov to v5 (#371) (04a6a42)

  • update dependency watchdog to v4 (#360) (cb8d383)

  • update pre-commit hook asottile/pyupgrade to v3.15.1 (#362) (dd2a521)

  • update pre-commit hook asottile/pyupgrade to v3.15.2 (3d02ad7)

  • update pre-commit hook psf/black-pre-commit-mirror to v24 (#356) (b46397d)

  • update pre-commit hook psf/black-pre-commit-mirror to v24.1.1 (#358) (7e4645e)

  • update pre-commit hook psf/black-pre-commit-mirror to v24.2.0 (#361) (5b56ace)

  • update pre-commit hook psf/black-pre-commit-mirror to v24.3.0 (3bbac5d)

  • update pre-commit hook pycqa/flake8 to v7 (#354) (66a582f)

  • update pypa/gh-action-pypi-publish action to v1.8.12 (#365) (55db255)

  • update pypa/gh-action-pypi-publish action to v1.8.14 (#367) (0cb615f)

1.33.2 (2024-01-02)

Bug Fixes

  • publish package to PyPI using OIDC auth (1a0e93b)

1.33.1 (2024-01-02)

Bug Fixes

  • private object not exported in top level module (#346) (5281b05)

Dependencies

  • update dependency coverage to >=7.4,<7.5 (#348) (3ac5711)

  • update dependency mypy to >=1.8,<1.9 (#343) (984022f)

  • update pre-commit hook psf/black-pre-commit-mirror to v23.12.1 (#347) (2c24efe)

1.33.0 (2023-12-19)

Features

  • add metrics endpoint for load balancers and servers (#331) (ee3c54f)

Bug Fixes

  • fallback to error code when message is unset (#328) (1c94153)

Dependencies

  • update actions/setup-python action to v5 (#335) (2ac252d)

  • update dependency sphinx-rtd-theme to v2 (#330) (7cc4335)

  • update pre-commit hook psf/black-pre-commit-mirror to v23.12.0 (#338) (38e4748)

  • update pre-commit hook pycqa/isort to v5.13.0 (#336) (3244cfe)

  • update pre-commit hook pycqa/isort to v5.13.1 (#337) (020a0ef)

  • update pre-commit hook pycqa/isort to v5.13.2 (#339) (b46df8c)

1.32.0 (2023-11-17)

Features

  • allow returning root_password in servers rebuild (#276) (38e098a)

Dependencies

  • update dependency mypy to >=1.7,<1.8 (#325) (7b59a2d)

  • update pre-commit hook pre-commit/mirrors-prettier to v3.1.0 (#326) (213b661)

  • update pre-commit hook psf/black-pre-commit-mirror to v23.10.1 (#322) (999afe3)

  • update pre-commit hook psf/black-pre-commit-mirror to v23.11.0 (#324) (7b2a24e)

1.31.0 (2023-10-23)

Features

  • prepare for iso deprecated field removal (#320) (beae328)

Dependencies

  • update pre-commit hook psf/black-pre-commit-mirror to v23.10.0 (#319) (184bbe6)

1.30.0 (2023-10-13)

Features

Dependencies

  • update dependency mypy to >=1.6,<1.7 (#317) (d248bbd)

  • update dependency pylint to v3 (#307) (277841d)

  • update pre-commit hook asottile/pyupgrade to v3.14.0 (#308) (07a4513)

  • update pre-commit hook asottile/pyupgrade to v3.15.0 (#312) (c544639)

  • update pre-commit hook pre-commit/pre-commit-hooks to v4.5.0 (#313) (e51eaa9)

  • update python docker tag to v3.12 (#309) (3a1ee67)

1.29.1 (2023-09-26)

Bug Fixes

  • prevent api calls when printing bound models (#305) (c1de7ef)

1.29.0 (2023-09-25)

Features

  • add domain attribute type hints to bound models (#300) (6d46d06)

  • firewalls: add applied_to_resources to FirewallResource (#297) (55d2b20)

Bug Fixes

  • missing BaseDomain base class inheritance (#303) (0ee7598)

Dependencies

  • update actions/checkout action to v4 (#295) (c02b446)

  • update dependency sphinx to >=7.2.2,<7.3 (#291) (10234ea)

  • update dependency sphinx to v7 (#211) (f635c94)

  • update pre-commit hook asottile/pyupgrade to v3.11.0 (#298) (4bbd0cc)

  • update pre-commit hook asottile/pyupgrade to v3.11.1 (#299) (2f9fcd7)

  • update pre-commit hook asottile/pyupgrade to v3.13.0 (#301) (951dbf3)

  • update pre-commit hook pre-commit/mirrors-prettier to v3.0.3 (#294) (381e336)

  • update pre-commit hook psf/black to v23.9.1 (#296) (4374a7b)

Documentation

  • load token from env in examples scripts (#302) (f18c9a6)

1.28.0 (2023-08-17)

Features

  • add load balancer target health status field (#288) (5780418)

  • implement resource actions clients (#252) (4bb9a97)

Dependencies

  • update dependency coverage to >=7.3,<7.4 (#286) (a4df4fa)

  • update dependency mypy to >=1.5,<1.6 (#284) (9dd5c81)

  • update pre-commit hook pre-commit/mirrors-prettier to v3.0.2 (#287) (6bf03cb)

Documentation

1.27.2 (2023-08-09)

Documentation

1.27.1 (2023-08-08)

Bug Fixes

  • missing long_description content_type in setup.py (#279) (6d79d1d)

1.27.0 (2023-08-08)

Features

Bug Fixes

  • allow omitting datacenter when creating a primary ip (#171) (4375dc6)

  • ineffective doc strings (#266) (bb34df9)

  • invalid attribute in placement group (#258) (23b3607)

Dependencies

  • update pre-commit hook asottile/pyupgrade to v3.10.1 (#261) (efa5780)

  • update pre-commit hook pre-commit/mirrors-prettier to v3.0.1 (#269) (2239b0b)

  • update pre-commit hook pycqa/flake8 to v6.1.0 (#260) (fd01384)

Documentation

1.26.0 (2023-07-19)

Features

1.25.0 (2023-07-14)

Features

  • add details to raise exceptions (#240) (cf64e54)

  • move hcloud.hcloud module to hcloud._client (#243) (413472d)

Dependencies

  • update pre-commit hook asottile/pyupgrade to v3.9.0 (#238) (0053ded)

  • update pre-commit hook pre-commit/mirrors-prettier to v3 (#235) (047d4e1)

  • update pre-commit hook psf/black to v23.7.0 (#239) (443bf26)

1.24.0 (2023-07-03)

Features

Dependencies

  • update pre-commit hook asottile/pyupgrade to v3.8.0 (#232) (27f21bc)

1.23.1 (2023-06-30)

Bug Fixes

  • handle Z timezone in ISO8601 datetime format (#228) (6a5c3f4), closes #226

1.23.0 (2023-06-26)

Features

Bug Fixes

  • isos: invalid name for include_wildcard_architecture argument (#222) (c3dfcab)

Dependencies

  • update dependency pytest to >=7.4,<7.5 (#217) (11e1f45)

1.22.0 (2023-06-22)

Features

Dependencies

  • update actions/setup-python action to v4 (#209) (aeee575)

  • update actions/stale action to v8 (#210) (cb13230)

  • update pre-commit hook asottile/pyupgrade to v3.7.0 (#205) (c46c5a4)

1.21.0 (2023-06-19)

Features

Bug Fixes

  • adjust label validation for max length of 63 characters (#194) (3cba96d)

Documentation

1.20.0 (2023-05-12)

Features

  • server_type: add field for included traffic (#185) (8ae0bc6)

v1.19.0 (2023-04-12)

  • docs: link to PrivateNet broken by @apricote in #177

  • feat: add support for ARM APIs by @apricote in #182

v1.18.2 (2022-12-27)

  • fix: remove unused future dependency by @apricote in #173

  • chore: update tests to use released python-3.11 by @apricote in #175

  • chore: prepare release 1.18.2 by @apricote in #174

v1.18.1 (2022-10-25)

  • Update Github Actions by @LKaemmerling in #165

  • Add tests for Python 3.11 by @LKaemmerling in #167

v1.18.0 (2022-08-17)

  • Remove use of external mock module by @s-t-e-v-e-n-k in #162

  • document installation path via conda-forge by @s-m-e in #149

  • Drop # – coding: utf-8 – from files by @jonasdlindner in #154

  • Simplify Requirement Constraints by @LKaemmerling in #163

  • Add validation helper for Label Values/Keys by @LKaemmerling in #164

v1.17.0 (2022-06-29)

  • Add primary IP support by @LKaemmerling in #160

v1.16.0 (2021-08-17)

  • Feature: Add support for Load Balancer DNS PTRs

v1.15.0 (2021-08-16)

  • Feature: Add support for Placement Groups

v1.14.1 (2021-08-10)

  • Bugfix: Fix crash on extra fields in public_net response

  • Improvement: Format code with black

v1.14.0 (2021-08-03)

  • Feature: Add support for Firewall rule descriptions

v1.13.0 (2021-07-16)

  • Feature: Add support for Firewall Protocols ESP and GRE

  • Feature: Add support for Image Type APP

  • Feature: Add support for creating Firewalls with Firewalls

  • Feature: Add support for Label Selectors in Firewalls

  • Improvement: Improve handling of underlying TCP connections. Now for every client instance a single TCP connection is used instead of one per call.

  • Note: Support for Python 2.7 and Python 3.5 was removed

v1.12.0 (2021-04-06)

  • Feature: Add support for managed Certificates

v1.11.0 (2021-03-11)

  • Feature: Add support for Firewalls

  • Feature: Add primary_disk_size to Server Domain

v1.10.0 (2020-11-03)

  • Feature: Add include_deprecated filter to get_list and get_all on ImagesClient

  • Feature: Add vSwitch support to add_subnet on NetworksClient

  • Feature: Add subnet type constants to NetworkSubnet domain (NetworkSubnet.TYPE_CLOUD, NetworkSubnet.TYPE_VSWITCH)

v1.9.1 (2020-08-11)

  • Bugfix: BoundLoadBalancer serialization failed when using IP targets

v1.9.0 (2020-08-10)

  • Feature: Add included_traffic, outgoing_traffic and ingoing_traffic properties to Load Balancer domain

  • Feature: Add change_type-method to LoadBalancersClient

  • Feature: Add support for LoadBalancerTargetLabelSelector

  • Feature: Add support for LoadBalancerTargetLabelSelector

v1.8.2 (2020-07-20)

  • Fix: Loosen up the requirements.

v1.8.1 (2020-06-29)

  • Fix Load Balancer Client.

  • Fix: Unify setting of request parameters within get_list methods.

1.8.0 (2020-06-22)

  • Feature: Add Load Balancers Attention: The Load Balancer support in v1.8.0 is kind of broken. Please use v1.8.1

  • Feature: Add Certificates

1.7.1 (2020-06-15)

  • Feature: Add requests 2.23 support

1.7.0 (2020-06-05)

  • Feature: Add support for the optional ‘networks’ parameter on server creation.

  • Feature: Add python 3.9 support

  • Feature: Add subnet type cloud

1.6.3 (2020-01-09)

  • Feature: Add ‘created’ property to SSH Key domain

  • Fix: Remove ISODatetime Descriptor because it leads to wrong dates

1.6.2 (2019-10-15)

  • Fix: future dependency requirement was too strict

1.6.1 (2019-10-01)

  • Fix: python-dateutil dependency requirement was too strict

1.6.0 (2019-09-17)

  • Feature: Add missing get_by_name on FloatingIPsClient

1.5.0 (2019-09-16)

  • Fix: ServersClient.create_image fails when specifying the labels

  • Feature: Add support for name on Floating IPs

1.4.1 (2019-08-19)

  • Fix: Documentation for NetworkRoute domain was missing

  • Fix: requests dependency requirement was to strict

1.4.0 (2019-07-29)

  • Feature: Add mac_address to Server PrivateNet domain

  • Feature: Add python 3.8 support

1.3.0 (2019-07-10)

  • Feature: Add status filter for servers, images and volumes

  • Feature: Add ‘created’ property to Floating IP domain

  • Feature: Add ‘Networks’ support

1.2.1 (2019-03-13)

  • Fix: BoundVolume.server server property now casted to the ‘BoundServer’.

1.2.0 (2019-03-06)

  • Feature: Add get_by_fingerprint-method for ssh keys

  • Fix: Create Floating IP with location raises an error because no action was given.

1.1.0 (2019-02-27)

  • Feature: Add STATUS-constants for server and volume status

1.0.1 (2019-02-22)

Fix: Ignore unknown fields in API response instead of raising an error

1.0.0 (2019-02-21)

  • First stable release.

    You can find the documentation under https://hcloud-python.readthedocs.io/en/stable/

0.1.0 (2018-12-20)

  • First release on GitHub.