open-consul/api
Paul Banks 6c77f7883e Misc comment cleanups 2018-06-25 12:24:16 -07:00
..
README.md
acl.go Spelling (#3958) 2018-03-19 16:56:00 +00:00
acl_test.go Adds a new /v1/acl/bootstrap API (#3349) 2017-08-02 17:05:18 -07:00
agent.go api: support native connect 2018-06-25 12:24:10 -07:00
agent_test.go Make tests pass and clean proxy persistence. No detached child changes yet. 2018-06-25 12:24:10 -07:00
api.go api: change Connect to a query option 2018-06-25 12:24:14 -07:00
api_test.go retry locks on network errors (#3553) 2017-10-11 07:42:10 -07:00
catalog.go Add Connect agent, catalog and health endpoints to api Client 2018-06-14 09:41:54 -07:00
catalog_test.go api: support native connect 2018-06-25 12:24:10 -07:00
connect.go api: fix up some comments and rename IssuedCert to LeafCert 2018-06-14 09:41:56 -07:00
connect_ca.go Add client api support for CA config endpoints 2018-06-14 09:42:22 -07:00
connect_ca_test.go Add client api support for CA config endpoints 2018-06-14 09:42:22 -07:00
connect_intention.go api: update intention struct for precedence 2018-06-25 12:24:16 -07:00
connect_intention_test.go api: IntentionUpdate API 2018-06-14 09:42:20 -07:00
coordinate.go Merge branch 'coordinate-node-endpoint' of github.com:hashicorp/consul into esm-changes 2017-10-26 19:20:24 -07:00
coordinate_test.go Move check definition to a sub-struct 2017-11-01 14:54:46 -07:00
event.go
event_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
health.go Misc comment cleanups 2018-06-25 12:24:16 -07:00
health_test.go Misc comment cleanups 2018-06-25 12:24:16 -07:00
kv.go Simplify string(buf.Bytes()) to buf.String() (#3590) 2017-10-18 13:26:09 -07:00
kv_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
lock.go Replace time.Now().Sub(x) with time.Since(x) 2017-10-17 20:38:24 +02:00
lock_test.go Replace time.Now().Sub(x) with time.Since(x) 2017-10-17 20:38:24 +02:00
operator.go
operator_area.go Cleans up some drift between the OSS and Enterprise trees. 2017-10-11 15:53:07 -07:00
operator_autopilot.go Simplify string(buf.Bytes()) to buf.String() (#3590) 2017-10-18 13:26:09 -07:00
operator_autopilot_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_keyring.go Shows the segment name in the keyring API and command output. 2017-09-07 12:17:39 -07:00
operator_keyring_test.go New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -07:00
operator_raft.go Move Raft protocol version for list peers end point to server side, fix unit tests. This fixes #3449 2017-09-26 09:35:39 -05:00
operator_raft_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_segment.go Change segment list endpoint in docs/client api 2017-09-01 12:40:07 -07:00
prepared_query.go api: change Connect to a query option 2018-06-25 12:24:14 -07:00
prepared_query_test.go Allow ignoring checks by ID when defining a PreparedQuery. Fixes #3727. 2018-04-10 14:04:16 +01:00
raw.go
semaphore.go Replace time.Now().Sub(x) with time.Since(x) 2017-10-17 20:38:24 +02:00
semaphore_test.go Replace time.Now().Sub(x) with time.Since(x) 2017-10-17 20:38:24 +02:00
session.go Expands and rework context support in the API client. (#3273) 2017-07-14 17:30:08 -07:00
session_test.go Tightens up the API test verification. 2017-12-14 09:07:57 -08:00
snapshot.go
snapshot_test.go api: refactor: prefix all API tests with API_ 2017-07-07 09:22:34 +02:00
status.go
status_test.go api: refactor: prefix all API tests with API_ 2017-07-07 09:22:34 +02: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)