tree: cb523fb05eb6cab60ff6bb64f56ac434bfd1800c [path history] [tgz]
  1. acl.go
  2. agent.go
  3. api.go
  4. catalog.go
  5. event.go
  6. health.go
  7. kv.go
  8. lock.go
  9. raw.go
  10. README.md
  11. semaphore.go
  12. session.go
  13. status.go
vendor/github.com/hashicorp/consul/api/README.md

Consul API client

This package provides the api package which attempts to provide programmatic access to the full Consul API.

Currently, all of the Consul APIs included in version 0.3 are supported.

Documentation

The full documentation is available on Godoc

Usage

Below is an example of using the Consul client:

// Get a new client, with KV endpoints
client, _ := api.NewClient(api.DefaultConfig())
kv := client.KV()

// PUT a new KV pair
p := &api.KVPair{Key: "foo", Value: []byte("test")}
_, err := kv.Put(p, nil)
if err != nil {
    panic(err)
}

// Lookup the pair
pair, _, err := kv.Get("foo", nil)
if err != nil {
    panic(err)
}
fmt.Printf("KV: %v", pair)