History

Sean Chittenden 65f9017c63 Update Check API to use constants Use constants where appropriate to advocate their use. Also add a deprecation notice re: `updateTTL`.		2016-04-23 16:01:59 -07:00
..
acl.go
acl_test.go
agent.go	Update Check API to use constants	2016-04-23 16:01:59 -07:00
agent_test.go	Update Check API to use constants	2016-04-23 16:01:59 -07:00
api.go	Improves the comment for the Address field.	2016-03-24 11:33:44 -07:00
api_test.go	Adds TLS config helper to API client.	2016-03-24 11:24:18 -07:00
catalog.go	Adds support for EnableTagOverride to the API client.	2016-02-16 11:45:29 -08:00
catalog_test.go	Update Check API to use constants	2016-04-23 16:01:59 -07:00
coordinate.go
coordinate_test.go
event.go
event_test.go
health.go	Added some constants in the api for check health statuses	2016-03-24 11:26:07 -07:00
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
prepared_query.go
prepared_query_test.go
raw.go
README.md
semaphore.go
semaphore_test.go
session.go
session_test.go
status.go
status_test.go

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.6.0 are supported.

Documentation

The full documentation is available on Godoc

Usage

Below is an example of using the Consul client:

// Get a new client
client, err := api.NewClient(api.DefaultConfig())
if err != nil {
    panic(err)
}

// Get a handle to the KV API
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)