open-consul/api
James Phillips 98140b4cf0 Merge pull request #1876 from hashicorp/f-tls-helper
Adds TLS config helper to API client.
2016-03-24 11:34:24 -07:00
..
README.md Use HTTPS + www. where appropriate 2016-01-13 17:44:01 -05:00
acl.go Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
acl_test.go api: run ACL tests by default 2015-06-13 23:51:30 +02:00
agent.go Added some constants in the api for check health statuses 2016-03-24 11:26:07 -07:00
agent_test.go Adds support for new PUT API for checks. 2016-03-04 15:18:25 -08: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 Adds support for EnableTagOverride to the API client. 2016-02-16 11:45:29 -08: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 Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
event_test.go api: improve test reliability 2015-05-12 12:10:25 -07:00
health.go Added some constants in the api for check health statuses 2016-03-24 11:26:07 -07:00
health_test.go api: run tests in parallel 2015-05-08 10:27:24 -07:00
kv.go Fix a bunch of typos. 2015-09-15 13:22:08 +01:00
kv_test.go Fixes a broken unit test introduced by #834. 2015-06-09 12:01:20 -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
prepared_query.go Removes a useless empty import and fixes some stale comments. 2015-11-17 08:29:20 -08:00
prepared_query_test.go Adds API client support for prepared queries. 2015-11-15 17:06:00 -08:00
raw.go api: Refactoring into shared write logic 2015-02-18 15:15:02 -08:00
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 Merge pull request #1041 from rboyer/api-fix-session-renew 2015-09-25 13:15:54 -07:00
session_test.go Correct the Session.Renew{,Periodic} to handle session expiration better 2015-09-14 08:52:32 -05:00
status.go Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
status_test.go api: run tests in parallel 2015-05-08 10:27:24 -07:00

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)