go-pantheon

go-pantheon is a GO client library for accessing the Patheon Systems Terminus API.

This is not an official Pantheon Systems project.

Usage

You'll need to get a machine token from Pantheon. Please see Creating and Revoking Machine Tokens from Pantheon documentation for instructions on how to manage your machine tokens. It is recommended you set this value as an environment variable. The following examples will assume your token has been set as an environment variable named TERMINUS_API_TOKEN.

You can import go-pantheon for use in Go by importing the following package:

import "github.com/drud/go-pantheon/pkg/pantheon"

Authentication

To use go-pantheon, you construct a new session, then use the various services on the client to access the Terminus API. For example:

// Create a new session for your API token.
session := pantheon.NewAuthSession(os.Getenv("TERMINUS_API_TOKEN"))

The session object is responsible for managing API sessions and requesting new session tokens as needed. To prevent requesting new sessions to often, it supports reading and writing session state to disk.

sessionLocation := "/home/user/.go-pantheon/savedsession"

session := pantheon.NewAuthSession(os.Getenv("TERMINUS_API_TOKEN"))


// Write a session to disk.
err := session.Write(sessionLocation)
if err != nil {
    log.Fatal(err)
}

// Read a previously saved session.
err := session.Read(sessionLocation)
if err != nil {
    log.Fatal(err)
}

Using the API

The following code shows how you would interact with the API to do the following tasks:

1. Get a site list for the currently authed user.
2. Get an environment list for the first site found
3. Get a list of backups for the "live" environment.
4. Get a S3 download URL for a database backup from the live environment.

// Get a list of all sites the authenticated user has access to.
SiteList := &pantheon.SiteList{}
err = session.Request("GET", SiteList)

// Get a list of environments for a given site.
site := SiteList.Sites[0]
environmentList := pantheon.NewEnvironmentList(site.ID)
err = session.Request("GET", environmentList)

// Get a list of all backups for the live.
env := environmentList.Environments["live"]
bl := pantheon.NewBackupList(site.ID, env.Name)
err = session.Request("GET", bl)

// Get a database backup for the live site.
dbBackup := &pantheon.Backup{}
if len(bl.Backups) > 0 {
    for _, backup := range bl.Backups {
        if backup.ArchiveType == "database" {
            // Get a time-limited backup URL from Pantheon. This requires a POST of the backup type to their API.
            dbBackup = &backup
            err = session.Request("POST", dbBackup)
            if err != nil {
                log.Fatal(err)
            }
            break
        }
    }
}

// Print the download URL.
fmt.Println(dbBackup.DownloadURL)