https://github.com/transip/gotransip

TransIP API client for Go
https://github.com/transip/gotransip

api golang transip transip-api-v6

Last synced: about 14 hours ago
JSON representation

TransIP API client for Go

• Host: GitHub
• URL: https://github.com/transip/gotransip
• Owner: transip
• License: mit
• Created: 2018-09-19T07:19:35.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T09:07:15.000Z (4 months ago)
• Last Synced: 2024-12-14T22:03:20.142Z (8 days ago)
• Topics: api, golang, transip, transip-api-v6
• Language: Go
• Size: 628 KB
• Stars: 29
• Watchers: 11
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gotransip - TransIP API client for Go

[![Go Report Card](https://goreportcard.com/badge/github.com/transip/gotransip)][goreport] [![Documentation](https://godoc.org/github.com/transip/gotransip?status.svg)][doc]

This is the Go client for the [TransIP API][api]. To use it you need an account with [TransIP][transip], enable API usage and setup a private API key.

**NOTE**: We keep the PHP version and golang version close as possible, but if something is not working 100% like you'd expect, please open an issue and of course: you're welcome to [contribute](CONTRIBUTING.md)!

## Example usage

To print a list of your account's VPSes:

```go

package main

import (

	"fmt"

	"github.com/transip/gotransip/v6"

	"github.com/transip/gotransip/v6/vps"

)

func main() {

	// create a new TransIP API client

	client, err := gotransip.NewClient(gotransip.ClientConfiguration{

		AccountName:    "accountName",

		PrivateKeyPath: "/path/to/api/private.key",

	})

	if err != nil {

		panic(err.Error())

	}

	vpsRepo := vps.Repository{Client: client}

	// get a list of your VPSes

	vpss, err := vpsRepo.GetAll()

	if err != nil {

		panic(err.Error())

	}

	pnRepo := vps.PrivateNetworkRepository{Client: client}

	// get a list of your private networks

	pns, err := pnRepo.GetAll()

	if err != nil {

		panic(err.Error())

	}

	// print name and description for each VPS

	for _, v := range vpss {

		fmt.Printf("vps: %s (%s)\n", v.Name, v.Description)

	}

	// print name and description for each private network

	for _, pn := range pns {

		fmt.Printf("privatenetwork: %s (%s)\n", pn.Name, pn.Description)

	}

	// order a new ubuntu 18.04 x8 vps, specifying a custom description,

	// so we can find out when the vps is delivered

	err = vpsRepo.Order(vps.Order{

		ProductName:       "vps-bladevps-x8",

		OperatingSystem:   "ubuntu-18.04",

		AvailabilityZone:  "ams0",

		Hostname:          "webserver01",

		Description:       "my-unique-description",

	})

	if err != nil {

		panic(err.Error())

	}

}

```

## Documentation

For detailed descriptions of all functions, check out the [TransIP API documentation][apidoc]. Details about the usage of the Go client can be found on [pkg.go.dev][doc].

[transip]: https://transip.nl/

[api]: https://api.transip.nl/

[doc]: https://pkg.go.dev/github.com/transip/gotransip/v6?tab=doc

[apidoc]: https://api.transip.nl/rest/docs.html

[goreport]: https://goreportcard.com/report/github.com/transip/gotransip