open-consul/api
Josh Soref 1dd8c378b9 Spelling (#3958)
* spelling: another

* spelling: autopilot

* spelling: beginning

* spelling: circonus

* spelling: default

* spelling: definition

* spelling: distance

* spelling: encountered

* spelling: enterprise

* spelling: expands

* spelling: exits

* spelling: formatting

* spelling: health

* spelling: hierarchy

* spelling: imposed

* spelling: independence

* spelling: inspect

* spelling: last

* spelling: latest

* spelling: client

* spelling: message

* spelling: minimum

* spelling: notify

* spelling: nonexistent

* spelling: operator

* spelling: payload

* spelling: preceded

* spelling: prepared

* spelling: programmatically

* spelling: required

* spelling: reconcile

* spelling: responses

* spelling: request

* spelling: response

* spelling: results

* spelling: retrieve

* spelling: service

* spelling: significantly

* spelling: specifies

* spelling: supported

* spelling: synchronization

* spelling: synchronous

* spelling: themselves

* spelling: unexpected

* spelling: validations

* spelling: value
2018-03-19 16:56:00 +00:00
..
README.md
acl.go Spelling (#3958) 2018-03-19 16:56:00 +00:00
acl_test.go
agent.go Add gRPC fields to client api and agent check endpoint docs 2018-02-09 16:02:27 -08:00
agent_test.go Added CheckID and Name to AgentServiceCheck struct 2018-01-08 15:59:55 -05:00
api.go Spelling (#3958) 2018-03-19 16:56:00 +00:00
api_test.go retry locks on network errors (#3553) 2017-10-11 07:42:10 -07:00
catalog.go Expose SkipNodeUpdate field and some health check info in the http api 2017-10-25 19:37:30 +02:00
catalog_test.go New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -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
health.go Move check definition to a sub-struct 2017-11-01 14:54:46 -07:00
health_test.go New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -07:00
kv.go Simplify string(buf.Bytes()) to buf.String() (#3590) 2017-10-18 13:26:09 -07:00
kv_test.go
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
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
operator_segment.go Change segment list endpoint in docs/client api 2017-09-01 12:40:07 -07:00
prepared_query.go Spelling (#3958) 2018-03-19 16:56:00 +00:00
prepared_query_test.go
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
session_test.go Tightens up the API test verification. 2017-12-14 09:07:57 -08:00
snapshot.go
snapshot_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)