modulepackage
1.1.0
Repository: https://github.com/bitlaunchio/gobitlaunch.git
Documentation: pkg.go.dev
# README
GoBitLaunch
GoBitLaunch is a Go client library for accessing the BitLaunch API.
You can view the client API docs here: http://godoc.org/github.com/bitlaunchio/gobitlaunch
You can view BitLaunch API docs here: https://developers.bitlaunch.io/
Install
go get -u github.com/bitlaunchio/gobitlaunch
Usage
import "github.com/bitlaunchio/gobitlaunch"
Authentication
You must use your API Token to authenticate with BitLaunch API. You can (re)generate your access token on the BitLaunch API Page.
You can then use your token to create a new client.
client := gobitlaunch.NewClient(token)
Documentation
For a comprehensive list of examples, check out the API documentation.
For details on all the functionality in this library, see the GoDoc
Contributing
Please do!
# Functions
NewClient takes an API token and returns a new BitLaunch API client.
# Structs
Account represents a BitLaunch account.
AccountHistory represents the usage data of a BitLaunch account.
AccountService manages account API actions.
AccountUsage represents the usage data of a BitLaunch account.
Client manages interaction with the API.
CreateOptionsService manages create options API actions.
CreateServerOptions defines options for creating a new server.
CreateTransactionOptions represents options for create a new transaction.
HostDisks represents a disk.
HostImage represents an image.
HostImageVersion represents an image version.
HostOptions represents what options a certain host provides.
HostPlanType represents the type of plan.
HostRegion represents a region.
HostSize represents a server size.
HostSubRegion represents a sub region.
Ports represents a port slice object.
RebuildOptions defines options for rebuilding a server.
Server represents a server.
ServerCreateOptions represents server creation options.
ServerService manages server API actions.
SSHKey represents an ssh key.
SSHKeyService manages ssh key API actions.
Transaction represents a transaction.
TransactionService manages account API actions.