DigitalOcean Go API client
Go
Latest commit 573489f Oct 30, 2017 @mauricio mauricio Merge pull request #154 from xmudrii/improve-readme
docs: replace first example with fully-runnable example
Permalink
Failed to load latest commit information.
context Portable Go Context Usage Apr 7, 2017
util Use context.Background over oauth2.NoContext May 4, 2017
.gitignore Add support for LoadBalancers Feb 14, 2017
.travis.yml Portable Go Context Usage Apr 7, 2017
CHANGELOG.md Tagging v1.1.1 Sep 29, 2017
CONTRIBUTING.md Add docs for contributing, versioning and docs. Mar 12, 2015
LICENSE.txt Update copyright notice to 2016 [ci skip] Jan 3, 2016
README.md docs: replace first example with fully-runnable example Oct 30, 2017
account.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
account_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
action.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
action_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
certificates.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
certificates_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
doc.go initial commit Sep 3, 2014
domains.go Handle flags & tag properties of domain record Oct 4, 2017
domains_test.go Handle flags & tag properties of domain record Oct 4, 2017
droplet_actions.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
droplet_actions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
droplets.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
droplets_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
errors.go Add checks for arguments Sep 25, 2015
errors_test.go Add checks for arguments Sep 25, 2015
firewalls.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
firewalls_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
floating_ips.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
floating_ips_actions.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
floating_ips_actions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
floating_ips_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
godo.go Follow User-Agent header field recommendations Sep 22, 2017
godo_test.go Follow User-Agent header field recommendations Sep 22, 2017
image_actions.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
image_actions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
images.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
images_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
keys.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
keys_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
links.go Portable Go Context Usage Apr 7, 2017
links_test.go Fix a few issues identified by go vet Dec 16, 2014
load_balancers.go Add AsRequest method on LoadBalancer Jul 22, 2017
load_balancers_test.go Add AsRequest method on LoadBalancer Jul 22, 2017
regions.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
regions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
sizes.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
sizes_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
snapshots.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
snapshots_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
storage.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
storage_actions.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
storage_actions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
storage_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
strings.go make linters happy Dec 21, 2016
tags.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
tags_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
timestamp.go removed named return Jul 16, 2015
timestamp_test.go make linters happy Dec 21, 2016

README.md

Build Status

Godo

Godo is a Go client library for accessing the DigitalOcean V2 API.

You can view the client API docs here: http://godoc.org/github.com/digitalocean/godo

You can view DigitalOcean API docs here: https://developers.digitalocean.com/documentation/v2/

Usage

import "github.com/digitalocean/godo"

Create a new DigitalOcean client, then use the exposed services to access different parts of the DigitalOcean API.

Authentication

Currently, Personal Access Token (PAT) is the only method of authenticating with the API. You can manage your tokens at the DigitalOcean Control Panel Applications Page.

You can then use your token to create a new client:

package main

import (
	"github.com/digitalocean/godo"
	"github.com/digitalocean/godo/context"
	"golang.org/x/oauth2"
)

const (
    pat = "mytoken"
)

type TokenSource struct {
	AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
	token := &oauth2.Token{
		AccessToken: t.AccessToken,
	}
	return token, nil
}

func main() {
	tokenSource := &TokenSource{
		AccessToken: pat,
	}

	oauthClient := oauth2.NewClient(context.Background(), tokenSource)
	client := godo.NewClient(oauthClient)
}

Examples

To create a new Droplet:

dropletName := "super-cool-droplet"

createRequest := &godo.DropletCreateRequest{
    Name:   dropletName,
    Region: "nyc3",
    Size:   "512mb",
    Image: godo.DropletCreateImage{
        Slug: "ubuntu-14-04-x64",
    },
}

ctx := context.TODO()

newDroplet, _, err := client.Droplets.Create(ctx, createRequest)

if err != nil {
    fmt.Printf("Something bad happened: %s\n\n", err)
    return err
}

Pagination

If a list of items is paginated by the API, you must request pages individually. For example, to fetch all Droplets:

func DropletList(ctx context.Context, client *godo.Client) ([]godo.Droplet, error) {
    // create a list to hold our droplets
    list := []godo.Droplet{}

    // create options. initially, these will be blank
    opt := &godo.ListOptions{}
    for {
        droplets, resp, err := client.Droplets.List(ctx, opt)
        if err != nil {
            return nil, err
        }

        // append the current page's droplets to our list
        for _, d := range droplets {
            list = append(list, d)
        }

        // if we are at the last page, break out the for loop
        if resp.Links == nil || resp.Links.IsLastPage() {
            break
        }

        page, err := resp.Links.CurrentPage()
        if err != nil {
            return nil, err
        }

        // set the page we want for the next request
        opt.Page = page + 1
    }

    return list, nil
}

Versioning

Each version of the client is tagged and the version is updated accordingly.

Since Go does not have a built-in versioning, a package management tool is recommended - a good one that works with git tags is gopkg.in.

To see the list of past versions, run git tag.

Documentation

For a comprehensive list of examples, check out the API documentation.

For details on all the functionality in this library, see the GoDoc documentation.

Contributing

We love pull requests! Please see the contribution guidelines.