History

Jeff Mitchell f1a67836d8 Use header to send Consul token rather than query param.		8 years ago
..
README.md	Use HTTPS + www. where appropriate	9 years ago
acl.go	…
acl_test.go	api: run ACL tests by default	10 years ago
agent.go	Correct a small typo	9 years ago
agent_test.go	Update Check API to use constants	9 years ago
api.go	Use header to send Consul token rather than query param.	8 years ago
api_test.go	Use header to send Consul token rather than query param.	8 years ago
catalog.go	Adds support for EnableTagOverride to the API client.	9 years ago
catalog_test.go	Update Check API to use constants	9 years ago
coordinate.go	Adds support for coordinates to client API.	9 years ago
coordinate_test.go	Adds support for coordinates to client API.	9 years ago
event.go	…
event_test.go	api: improve test reliability	10 years ago
health.go	Added some constants in the api for check health statuses	9 years ago
health_test.go	api: run tests in parallel	10 years ago
kv.go	Adds a get-tree verb to KV transaction operations.	9 years ago
kv_test.go	Adds a read-only optimized path for transactions.	9 years ago
lock.go	Use HTTPS + www. where appropriate	9 years ago
lock_test.go	Makes the timeout behavior more intuitive.	9 years ago
prepared_query.go	api: add query templates	9 years ago
prepared_query_test.go	Adds API client support for prepared queries.	9 years ago
raw.go	api: Refactoring into shared write logic	10 years ago
semaphore.go	Factors server error checking into a new function.	9 years ago
semaphore_test.go	Makes the timeout behavior more intuitive.	9 years ago
session.go	Merge pull request #1041 from rboyer/api-fix-session-renew	9 years ago
session_test.go	Correct the Session.Renew{,Periodic} to handle session expiration better	9 years ago
status.go	…
status_test.go	api: run tests in parallel	10 years ago

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)