hrobot-rs ![Latest Version] ![Docs]

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

See the trait implementations for Robot 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 Robot client object and fetching a list of all dedicated servers owned by the account identified by username ```rust use hrobot::*;

let client = Robot::new( &std::env::var("HROBOTUSERNAME").unwrap(), &std::env::var("HROBOTPASSWORD").unwrap() );

for server in client.list_servers().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 anonymized output below text foobar: AX51-NVMe in FSN1-DC18

API Endpoint Implementation Progress

• ❌ Failover: Not implemented.
• ❌ Traffic: Not implemented.
• ❌ Server Ordering: Not implemented. I'm not made of money!
• ❌ Storage Box: Not implemented.
• ⚠️ Firewall
  • ✅ get & update firewall rules & configuration directly.
  • ❌ create, modify or delete firewall templates.
  • ❌ apply firewall templates.
• ⚠️ IP
  • ✅ get ip address information.
  • ✅ get mac address information.
  • ❌ update traffic warnings for IP.
  • ❌ modify or delete additional MAC-addresses.
• ⚠️ Subnet
  • ✅ list & get subnets.
  • ❌ update traffic warnings for subnet.
  • ❌ get subnet MAC.
  • ❌ update subnet MAC.
  • ❌ delete subnet MAC.
• ✅ vSwitch: All functionality implemented.
• ✅ Server: All functionality implemented.
• ✅ Reset: All functionality implemented.
• ✅ Wake On Lan: All functionality implemented.
• ✅ Boot Configuration: All functionality implemented (but some untested due to costs of add-ons).
• ✅ Reverse DNS: All functionality implemented.
• ✅ SSH Keys: All functionality implemented.

Testing

Testing relies on $HROBOT_USERNAME and $HROBOT_PASSWORD being defined in the environment, corresponding to a Hetzner WebService/app login.

Some of the tests which interact with the Hetzner API can be disruptive, and therefore any test which interacts with Hetzner is marked as #[ignore] just in case cargo test is accidentally run while the HROBOT_USERNAME and HROBOT_PASSWORD environment variables are available. To explicitly run these potentially disruptive tests, either use cargo test -- --ignored to run all of them, or run the test explicitly using cargo test server::tests::list_servers -- --ignored