open-consul/api
Kyle Havlovitz 107d7f6c5a
Add rpc_listener option to segment config
2017-08-30 11:58:29 -07:00
..
README.md
acl.go Adds a new /v1/acl/bootstrap API (#3349) 2017-08-02 17:05:18 -07:00
acl_test.go Adds a new /v1/acl/bootstrap API (#3349) 2017-08-02 17:05:18 -07:00
agent.go Adds open source side of network segments (feature is Enterprise-only). 2017-08-30 11:58:29 -07:00
agent_test.go Update api structs for metrics endpoint 2017-08-08 12:33:59 -07:00
api.go Add rpc_listener option to segment config 2017-08-30 11:58:29 -07:00
api_test.go
catalog.go
catalog_test.go Adds open source side of network segments (feature is Enterprise-only). 2017-08-30 11:58:29 -07:00
coordinate.go Adds open source side of network segments (feature is Enterprise-only). 2017-08-30 11:58:29 -07:00
coordinate_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
event.go
event_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
health.go
health_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
kv.go
kv_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
lock.go
lock_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator.go
operator_area.go
operator_autopilot.go Add UpgradeVersionTag to autopilot config 2017-07-18 13:35:41 -07:00
operator_autopilot_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_keyring.go
operator_keyring_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_raft.go
operator_raft_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_segment.go Adds open source side of network segments (feature is Enterprise-only). 2017-08-30 11:58:29 -07:00
prepared_query.go
prepared_query_test.go
raw.go
semaphore.go
semaphore_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +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 Expands and rework context support in the API client. (#3273) 2017-07-14 17:30:08 -07: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)