DigitalOcean Go API client
Branch: master
Clone or download
Latest commit 886fc5e Feb 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
util Remove support for Go 1.6 (#166) May 8, 2018
.gitignore Add support for LoadBalancers Feb 14, 2017
.travis.yml Remove support for Go 1.6 (#166) May 8, 2018
CHANGELOG.md allow tagging volumes Feb 12, 2019
CONTRIBUTING.md Add Testify dependency to CONTRIBUTING.md Oct 10, 2018
LICENSE.txt Update copyright notice to 2016 [ci skip] Jan 3, 2016
README.md Fix Example in README.md (#168) May 10, 2018
account.go Adding `VolumeLimit` to account. Aug 30, 2018
account_test.go Adding `VolumeLimit` to account. Aug 30, 2018
action.go Remove support for Go 1.6 (#166) May 8, 2018
action_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
cdn.go storage: fix cdn flush cache cdn endpoint and fix changelog Aug 23, 2018
cdn_test.go storage: fix cdn flush cache cdn endpoint and fix changelog Aug 23, 2018
certificates.go Add support for Let's Encrypt Certificates. (#165) May 8, 2018
certificates_test.go Add support for Let's Encrypt Certificates. (#165) May 8, 2018
doc.go initial commit Sep 3, 2014
domains.go Fix return of Domains.EditRecord function (Fixes: #198). Jan 29, 2019
domains_test.go Fix return of Domains.EditRecord function (Fixes: #198). Jan 29, 2019
droplet_actions.go Remove updrage droplet action (deprecated) May 10, 2018
droplet_actions_test.go Remove updrage droplet action (deprecated) May 10, 2018
droplets.go add projects support Oct 16, 2018
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 add projects support Oct 16, 2018
firewalls_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
floating_ips.go add projects support Oct 16, 2018
floating_ips_actions.go Remove support for Go 1.6 (#166) May 8, 2018
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 allow tagging volumes Feb 12, 2019
godo_test.go storage: add support for spaces cdn Aug 22, 2018
image_actions.go Remove support for Go 1.6 (#166) May 8, 2018
image_actions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
images.go Add support for creating custom images and listing images by tag. (#186) Nov 13, 2018
images_test.go Add support for creating custom images and listing images by tag. (#186) Nov 13, 2018
keys.go Remove support for Go 1.6 (#166) May 8, 2018
keys_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
kubernetes.go k8saas: remove defaults from options Nov 29, 2018
kubernetes_test.go k8saas: remove defaults from options Nov 29, 2018
links.go Remove support for Go 1.6 (#166) May 8, 2018
links_test.go Fix a few issues identified by go vet Dec 16, 2014
load_balancers.go LB: Adding tag support for creating LB (#196) Dec 18, 2018
load_balancers_test.go LB: Adding tag support for creating LB (#196) Dec 18, 2018
projects.go remove excessive type assertions Jan 22, 2019
projects_test.go add projects support Oct 16, 2018
regions.go Remove support for Go 1.6 (#166) May 8, 2018
regions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
sizes.go Remove support for Go 1.6 (#166) May 8, 2018
sizes_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
snapshots.go Remove support for Go 1.6 (#166) May 8, 2018
snapshots_test.go Remove support for Go 1.6 (#166) May 8, 2018
storage.go add projects support Oct 16, 2018
storage_actions.go Remove support for Go 1.6 (#166) May 8, 2018
storage_actions_test.go use http.MethodX instead of "GET"/"POST"/"DELETE" Jul 2, 2017
storage_test.go storage: Add support for volume formatting May 23, 2018
strings.go add projects support Oct 16, 2018
tags.go allow tagging volumes Feb 12, 2019
tags_test.go allow tagging volumes Feb 12, 2019
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 (
	"context"
	"github.com/digitalocean/godo"
	"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:   "s-1vcpu-1gb",
    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.