open-consul/api
James Phillips 5e4db081f7
Removes Raft types from public API interface.
This will cause a lot of breakage because we've currently vendored a
branch of the Raft library.
2016-08-30 14:59:16 -07:00
..
README.md Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
acl.go
acl_test.go
agent.go Fixes a typo and adds an admonition about only being in Consul 0.7+. 2016-08-16 09:27:20 -07:00
agent_test.go Adds ability to deregister a service based on critical check state longer than a timeout. 2016-08-16 01:00:26 -07:00
api.go Adds an `X-Consul-Translate-Addresses` to signal translation is enabled. 2016-08-16 11:31:41 -07:00
api_test.go Adds an `X-Consul-Translate-Addresses` to signal translation is enabled. 2016-08-16 11:31:41 -07:00
catalog.go Adds missing TaggedAddress structures to API client. 2016-08-16 10:30:30 -07:00
catalog_test.go Adds missing TaggedAddress structures to API client. 2016-08-16 10:30:30 -07:00
coordinate.go Adds support for coordinates to client API. 2015-10-23 15:23:01 -07:00
coordinate_test.go Adds support for coordinates to client API. 2015-10-23 15:23:01 -07:00
event.go
event_test.go
health.go Fixes #1775; Removes 'unknown' state 2016-07-30 19:33:14 +05:30
health_test.go Adds missing TaggedAddress structures to API client. 2016-08-16 10:30:30 -07:00
kv.go Adds a get-tree verb to KV transaction operations. 2016-05-13 16:57:39 -07:00
kv_test.go Adds a read-only optimized path for transactions. 2016-05-13 00:34:05 -07:00
lock.go Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
lock_test.go Makes the timeout behavior more intuitive. 2016-01-06 09:40:20 -08:00
operator.go Removes Raft types from public API interface. 2016-08-30 14:59:16 -07:00
operator_test.go Makes the Raft configuration API easier to consume. 2016-08-30 11:30:56 -07:00
prepared_query.go api: add query templates 2016-07-02 16:05:41 -07:00
prepared_query_test.go Adds missing TaggedAddress structures to API client. 2016-08-16 10:30:30 -07:00
raw.go
semaphore.go Factors server error checking into a new function. 2016-01-06 11:35:16 -08:00
semaphore_test.go Makes the timeout behavior more intuitive. 2016-01-06 09:40:20 -08:00
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)