Get the Ruby Cloud Server SDK

Table of Contents

Introduction

The 1&1 Ruby SDK is a Ruby gem designed for interaction with the 1&1 Cloud platform over the Cloud Server REST API. This allows you to automate many of the tasks which are otherwise available through the Cloud Panel UI.

To view or contribute to this project, visit the GitHub repository.

Features

The 1&1 Ruby SDK allows you to list and retrieve information about servers, including their hardware, IP addresses, load balancers, private networks, and more. You can create and delete servers, as well as reconfigure them. Hard drives, virtual DVD units, firewall policies, load balancers, and IP addresses can all be added or removed through the API.

The API also allows you to manage server operations. Servers can be added to or removed from private networks. Snapshots can be created, restored, or removed. Images can be created, updated, and deleted. Shared storages, firewall policies, load balancers, IP addresses, private networks, VPNs, monitoring policies, logs, usage, and appliances can all be managed through the API. Users and roles can be added, deleted, and managed, as well.

Supported Versions

The 1&1 Ruby SDK is designed for Ruby version 2.3.0 and above.

Getting Started

Before you begin you will need to have signed-up for a 1&1 account. The credentials you setup during sign-up will be used to authenticate against the API.

Installation

You can install the latest stable version using:

$ gem install 1and1

Authentication

Connecting to 1&1 is handled by first setting up your authentication. Start your application by initializing the module with your API token.

require 'oneandone'

OneAndOne.start('<API-TOKEN>')

Updated 6/22/2017

Comments

Tags: Ruby