Hetzner Cloud Python
Official Hetzner Cloud python library.
The library's documentation is available at hcloud-python.readthedocs.io, the public API documentation is available at docs.hetzner.cloud.
[!IMPORTANT] Make sure to follow our API changelog available at docs.hetzner.cloud/changelog (or the RSS feed available at docs.hetzner.cloud/changelog/feed.rss) to be notified about additions, deprecations and removals.
Usage
Install the hcloud library:
pip install hcloud
For more installation details, please see the installation docs.
Here is an example that creates a server and list them:
from hcloud import Client
from hcloud.images import Image
from hcloud.server_types import ServerType
client = Client(
token="{YOUR_API_TOKEN}", # Please paste your API token here
application_name="my-app",
application_version="v1.0.0",
)
# Create a server named my-server
response = client.servers.create(
name="my-server",
server_type=ServerType(name="cx23"),
image=Image(name="ubuntu-22.04"),
)
server = response.server
print(f"{server.id=} {server.name=} {server.status=}")
print(f"root password: {response.root_password}")
# List your servers
servers = client.servers.get_all()
for server in servers:
print(f"{server.id=} {server.name=} {server.status=}")
- To upgrade the package, please read the instructions available in the documentation.
- For more details on the API, please see the API reference.
- You can find some more examples under the
examples/directory.
Supported Python versions
We support python versions until end-of-life.
Experimental features
Experimental features are published as part of our regular releases (e.g. a product public beta). During an experimental phase, breaking changes on those features may occur within minor releases.
The stability of experimental features is not related to the stability of its upstream API.
Experimental features have different levels of maturity (e.g. experimental, alpha, beta) based on the maturity of the upstream API.
While experimental features will be announced in the release notes, you can also find whether a python class or function is experimental in its docstring:
Experimental:
$PRODUCT is $MATURITY, breaking changes may occur within minor releases.
See https://docs.hetzner.cloud/changelog#$SLUG for more details.
Development
First, create a virtual environment and activate it:
make venv
source venv/bin/activate
You may setup pre-commit to run before you commit changes, this removes the need to run it manually afterwards:
pre-commit install
You can then run different tasks defined in the Makefile, below are the most important ones:
Build the documentation and open it in your browser:
make docs
Lint the code:
make lint
Run tests using the current python3 version:
make test
You may also run the tests for multiple python3 versions using tox:
tox .
Deprecations implementation
When deprecating a module or a function, you must:
- Update the docstring with a
deprecatednotice:
"""Get image by name
.. deprecated:: 1.19
Use :func:`hcloud.images.client.ImagesClient.get_by_name_and_architecture` instead.
"""
- Raise a warning when the deprecated module or function is being used:
warnings.warn(
"The 'hcloud.images.client.ImagesClient.get_by_name' method is deprecated, please use the "
"'hcloud.images.client.ImagesClient.get_by_name_and_architecture' method instead.",
DeprecationWarning,
stacklevel=2,
)
Releasing experimental features
To publish experimental features as part of regular releases:
-
an announcement, including a link to a changelog entry, must be added to the release notes.
-
an
Experimentalnotice, including a link to a changelog entry, must be added to the python classes and functions that are experimental:""" Experimental: $PRODUCT is $MATURITY, breaking changes may occur within minor releases. See https://docs.hetzner.cloud/changelog#$SLUG for more details. """
License
The MIT License (MIT). Please see License File for more information.
2 maintainers
Release files for hcloud 2.24.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hcloud-2.24.0.tar.gz | 155.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hcloud-2.24.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 267.4 kB
Release files / hcloud-2.24.0.tar.gz
| Download URL | hcloud-2.24.0.tar.gz |
|---|---|
| Size | 155.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4b210d7f276193300534c240b22789a6c6a65a1f350051504a4918ee1da1c396
|
|
BLAKE2b-256 checksum How to use checksums |
a29ab5f393aa5ed49b1a8ac794f7e9c939a70bdd21676a6e1957de1b509dd98b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency logRelease files / hcloud-2.24.0-py3-none-any.whl
| Download URL | hcloud-2.24.0-py3-none-any.whl |
|---|---|
| Size | 111.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e8d3cdaad7def81acf644b8be5bb977df3a5c52ffec2006b7422b0b65b93753b
|
|
BLAKE2b-256 checksum How to use checksums |
15ed2a86abd2f0261194a90b033d0a3959d9db69d1beb2cd68df86d2ec3a1420
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 11, 2026.
Transparency log
