client

README

hrobot-go: A Go library for the Hetzner Robot Webservice

Package hrobot-go is a library for the Hetzner Robot Webservice.

The library’s documentation is available at GoDoc, the public API documentation is available at robot.your-server.de.

Example

package main

import (
    "fmt"
    "log"

    client "github.com/nl2go/hrobot-go"
)

func main() {
    robotClient := client.NewBasicAuthClient("user", "pass")

    servers, err := robotClient.ServerGetList()
    if err != nil {
        log.Fatalf("error while retrieving server list: %s\n", err)
    }

    fmt.Println(servers)
}

Documentation

Index

• type Client
  • func (c *Client) BootRescueGet(ip string) (*models.Rescue, error)
  • func (c *Client) BootRescueSet(ip string, input *models.RescueSetInput) (*models.Rescue, error)
  • func (c *Client) FailoverGet(ip string) (*models.Failover, error)
  • func (c *Client) FailoverGetList() ([]models.Failover, error)
  • func (c *Client) GetVersion() string
  • func (c *Client) IPGetList() ([]models.IP, error)
  • func (c *Client) KeyGetList() ([]models.Key, error)
  • func (c *Client) RDnsGet(ip string) (*models.Rdns, error)
  • func (c *Client) RDnsGetList() ([]models.Rdns, error)
  • func (c *Client) ResetGet(ip string) (*models.Reset, error)
  • func (c *Client) ResetSet(ip string, input *models.ResetSetInput) (*models.ResetPost, error)
  • func (c *Client) ServerGet(ip string) (*models.Server, error)
  • func (c *Client) ServerGetList() ([]models.Server, error)
  • func (c *Client) ServerReverse(ip string) (*models.Cancellation, error)
  • func (c *Client) ServerSetName(ip string, input *models.ServerSetNameInput) (*models.Server, error)
  • func (c *Client) SetBaseURL(baseURL string)
  • func (c *Client) SetUserAgent(userAgent string)
• type RobotClient
  • func NewBasicAuthClient(username, password string) RobotClient

Types

type Client

type Client struct {
	Username string
	Password string
	// contains filtered or unexported fields
}

func (*Client) BootRescueGet

func (c *Client) BootRescueGet(ip string) (*models.Rescue, error)

func (*Client) BootRescueSet

func (c *Client) BootRescueSet(ip string, input *models.RescueSetInput) (*models.Rescue, error)

func (*Client) FailoverGet

func (c *Client) FailoverGet(ip string) (*models.Failover, error)

func (*Client) FailoverGetList

func (c *Client) FailoverGetList() ([]models.Failover, error)

func (*Client) GetVersion

func (c *Client) GetVersion() string

func (*Client) IPGetList

func (c *Client) IPGetList() ([]models.IP, error)

func (*Client) KeyGetList

func (c *Client) KeyGetList() ([]models.Key, error)

func (*Client) RDnsGet

func (c *Client) RDnsGet(ip string) (*models.Rdns, error)

func (*Client) RDnsGetList

func (c *Client) RDnsGetList() ([]models.Rdns, error)

func (*Client) ResetGet

func (c *Client) ResetGet(ip string) (*models.Reset, error)

func (*Client) ResetSet

func (c *Client) ResetSet(ip string, input *models.ResetSetInput) (*models.ResetPost, error)

func (*Client) ServerGet

func (c *Client) ServerGet(ip string) (*models.Server, error)

func (*Client) ServerGetList

func (c *Client) ServerGetList() ([]models.Server, error)

func (*Client) ServerReverse

func (c *Client) ServerReverse(ip string) (*models.Cancellation, error)

func (*Client) ServerSetName

func (c *Client) ServerSetName(ip string, input *models.ServerSetNameInput) (*models.Server, error)

func (*Client) SetBaseURL

func (c *Client) SetBaseURL(baseURL string)

func (*Client) SetUserAgent

func (c *Client) SetUserAgent(userAgent string)

type RobotClient

type RobotClient interface {
	SetBaseURL(baseURL string)
	SetUserAgent(userAgent string)
	GetVersion() string
	ServerGetList() ([]models.Server, error)
	ServerGet(ip string) (*models.Server, error)
	ServerSetName(ip string, input *models.ServerSetNameInput) (*models.Server, error)
	ServerReverse(ip string) (*models.Cancellation, error)
	KeyGetList() ([]models.Key, error)
	IPGetList() ([]models.IP, error)
	RDnsGetList() ([]models.Rdns, error)
	RDnsGet(ip string) (*models.Rdns, error)
	BootRescueGet(ip string) (*models.Rescue, error)
	BootRescueSet(ip string, input *models.RescueSetInput) (*models.Rescue, error)
	ResetGet(ip string) (*models.Reset, error)
	ResetSet(ip string, input *models.ResetSetInput) (*models.ResetPost, error)
	FailoverGetList() ([]models.Failover, error)
	FailoverGet(ip string) (*models.Failover, error)
}

func NewBasicAuthClient

func NewBasicAuthClient(username, password string) RobotClient