hrobot-rs

hrobot is an unofficial asynchronous Rust client for interacting with the Hetzner Robot API

See the AsyncRobot struct for a complete list of supported API Endpoints.

Disclaimer: the authors are not associated with Hetzner (except as customers), and the crate is in no way endorsed or supported by Hetzner Online GmbH.

Requirements for usage

A Hetzner WebService/app user is required to make use of this library.

If you already have a Hetzner account, you can create one through the Hetzner Robot web interface under Settings/Preferences.

Example

Here's a quick example showing how to instantiate the AsyncRobot client object and fetching a list of all dedicated servers owned by the account identified by username

use hrobot::*;

#[tokio::main]
async fn main() {
    // Robot is instantiated using the environment
    // variables HROBOT_USERNAME an HROBOT_PASSWORD.
    let robot = AsyncRobot::default();

    for server in robot.list_servers().await.unwrap() {
        println!("{name}: {product} in {location}",
            name = server.name,
            product = server.product,
            location = server.dc
        );
    }
}

Running the above example should yield something similar to the output below:

foo: AX51-NVMe in FSN1-DC18
bar: Server Auction in FSN1-DC5

API Endpoint Implementation Progress

The entire Hetzner Robot API is covered at this point!

Some endpoints have not been tested due to the cost and disruption to running servers, so please consult the section below for a detailed overview of the endpoints.

Detailed API overview.

Warning!

¹ not tested, use at your own risk.

² not officially documented by Hetzner, use at own risk.

Testing

Tests are divided into three categories:

Isolated tests.

These do not touch the Hetzner API at all and generally test assumptions made in some of the constructs of the library such as serialization/deserialization from known API output. These are always safe to run and do not require Hetzner credentials.
Non-disruptive tests.

These interact with the live Hetzner API using credentials provided via the environment variables HROBOT_USERNAME and HROBOT_PASSWORD.

The tests fail if these credentials are not available. These tests only perform actions that have no side-effects (such as get/list), and are therefore somewhat safe to execute, but can trigger the rate limiting of the Hetzner API.

These tests are only enabled if the feature non-disruptive-tests is enabled.
Disruptive tests.

These interact with the live Hetzner API using credentials provided via the environment variables HROBOT_USERNAME and HROBOT_PASSWORD.

Unlike non-disruptive tests, these tests will interact with and modify existing resources within the provided account, including but not limited to:
- Modifying and deleting the firewall of servers.
- Changing the backup schedule of storageboxes.
- Adding and deleting SSH Keys.
- Ordering and cancelling vSwitches, etc.
Most of these tests are designed to return the resource to its initial state upon completion, but that assumes the test succeeds!

Suffice to say, these tests are incredibly dangerous and should never be run in a production Hetzner account without explicit supervision.

To make sure these are not run accidentally, you have to enable the disruptive-tests feature AND and pass the --ignored flag when running cargo test as the tests have been explicitly marked as ignored along with reasoning as to why.

Not tested, but should work. Use at own risk. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷ ↩⁸ ↩⁹ ↩¹⁰ ↩¹¹ ↩¹² ↩¹³ ↩¹⁴ ↩¹⁵ ↩¹⁶ ↩¹⁷ ↩¹⁸ ↩¹⁹ ↩²⁰ ↩²¹ ↩²² ↩²³ ↩²⁴ ↩²⁵ ↩²⁶ ↩²⁷ ↩²⁸ ↩²⁹ ↩³⁰ ↩³¹ ↩³² ↩³³ ↩³⁴ ↩³⁵ ↩³⁶ ↩³⁷ ↩³⁸ ↩³⁹
Not officially documented by Hetzner, use at own risk. ↩ ↩² ↩³ ↩⁴ ↩⁵

fritexvz / hrobot-rs

hrobot-rs

Requirements for usage

Example

API Endpoint Implementation Progress

Testing

About

Languages

hrobot-rs

Requirements for usage

Example

API Endpoint Implementation Progress

Testing

Footnotes

About

Languages