Use bytesize crate for any byte measurement

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 two categories:

Unit tests. s 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.
Integration tests. ⚠️

These tests do interact with the Hetzner API, and therefore require the following two environment variables to be set:
- HROBOT_USERNAME
- HROBOT_PASSWORD
These tests will ⚠️ PURCHASE AN AUCTION SERVER ⚠️ and (ideally) cancel the server once tests have run.

They interact ⚠️ DESTRUCTIVELY ⚠️ with the resources provided through the following environment variables:
- HETZNER_INTEGRATION_TEST_STORAGEBOX_ID specifies a pre-allocated storagebox resource which Storagebox-related tests are run against.

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

	/// IP Addresses associated with this server.
	///
	/// Includes both IPv4 and IPv6 but excludes associated subnets,
	/// which are instead listed in [`subnets`](Server::subnets)
	#[serde(rename = "ip", default)]
	pub ips: Vec<String>,

mathiaspius / hrobot-rs Goto Github PK

hrobot-rs's Introduction

hrobot-rs

Requirements for usage

Example

API Endpoint Implementation Progress

Testing

Footnotes

hrobot-rs's People

Contributors

Stargazers

Watchers

Forkers

hrobot-rs's Issues

Recommend Projects

Recommend Topics

Recommend Org