hcloud-python Documentation

The library distinguishes between raw data models and client-aware objects:

1. Iso: A domain object representing the data of an ISO image (e.g., name, size, etc.). It is a pure data container.
2. BoundIso: A wrapper around an Iso that is 'bound' to an IsosClient. Use BoundIso when you need to perform actions on a specific ISO, such as deleting it, because it contains the necessary client context to make subsequent API calls.

The library provides several key data models for DNS management:

• Zone: Represents a DNS zone.
• ZoneRecord: Represents an individual DNS record.
• ZoneRRSet: Represents a Resource Record Set (a group of records for the same name and type).
• ZoneAuthoritativeNameservers: Represents the nameservers authoritative for a zone.
• ZonePrimaryNameserver: Represents the primary nameserver of a zone.
• CreateZoneResponse: The response object returned when creating a new zone.

The hcloud.servers module contains several key domain classes used to represent server state and API responses:

• Server: Represents a Hetzner Cloud server.
• BoundServer: Represents a server that is associated with specific resources (often used in the context of network bindings).
• PublicNetwork: Represents a public network configuration.
• IPv4Address: Represents an IPv4 address assigned to a server.
• IPv6Network: Represents an IPv6 network configuration.

Response Objects: When performing actions, the API returns specific response types:

• CreateServerResponse: Returned after a successful server creation.
• ResetPasswordResponse: Returned after a password reset operation.
• EnableRescueResponse: Returned after enabling rescue mode.
• RequestConsoleResponse: Returned after requesting a console session.

When performing or monitoring actions, the library uses two primary data models:

1. BoundAction: Represents an action that is currently associated with or 'bound' to a specific resource.
2. Action: Represents the core definition of an action performed within the Hetzner Cloud environment.

These objects are returned by the ActionsClient to provide state information about the operation being executed.

The SSH key functionality uses two main data models:

1. SSHKey: A domain object representing the core properties of an SSH key (such as its ID, name, and public key string).
2. BoundSSHKey: A specialized object used when an SSH key is associated with a specific resource (like a server).

When working with the ServerTypesClient, you will encounter two main data models:

1. ServerType: Represents the definition of a server type (e.g., CPU, RAM, Disk capacity, and name).
2. BoundServerType: Represents a server type that is specifically associated with a particular context or resource, often used when inspecting the relationship between existing servers and their underlying hardware definitions.

When working with placement groups, the library provides two main domain objects:

• PlacementGroup: Represents a placement group definition.
• BoundPlacementGroup: Represents a placement group that has been associated with specific resources (like servers).

These objects are returned by the PlacementGroupsClient methods during creation or retrieval operations.

Experimental features (e.g., products in public beta) are included in regular releases. Because they are experimental, breaking changes may occur within minor releases.

Experimental features have different maturity levels (e.g., experimental, alpha, beta) based on the upstream API. You can identify experimental classes or functions by checking their docstrings, which follow this format:

Experimental:
    $PRODUCT is $MATURITY, breaking changes may occur within minor releases.
    See https://docs.hetzner.cloud/changelog#$SLUG for more details.

Install the official Hetzner Cloud Python library using pip:

pip install hcloud

You can install Hetzner Cloud Python using conda from the conda-forge channel. Note that this package is maintained by the community and not by Hetzner Cloud, so it may be outdated compared to the official PyPI release.

$ conda install -c conda-forge hcloud

The preferred method to install the stable release of Hetzner Cloud Python is using pip. This ensures you receive the most recent stable version available on PyPI.

$ pip install hcloud