open-consul/api
Kyle Havlovitz 8544ee9d71
Re-add ReadableDuration types to health check definition
This is to fix the backwards-incompatible change made in 1.4.1 by
changing these fields to time.Duration.
2019-01-25 14:47:35 -08:00
..
acl.go
acl_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
agent.go Implement /v1/agent/health/service/<service name> endpoint (#3551) 2019-01-07 09:39:23 -05:00
agent_test.go agent: add default weights to service in local state to prevent AE churn (#5126) 2019-01-08 10:13:49 +00:00
api.go Implement /v1/agent/health/service/<service name> endpoint (#3551) 2019-01-07 09:39:23 -05:00
api_test.go
catalog.go
catalog_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
connect.go
connect_ca.go connect: tame thundering herd of CSRs on CA rotation (#5228) 2019-01-22 17:19:36 +00:00
connect_ca_test.go
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
event.go
event_test.go
health.go Re-add ReadableDuration types to health check definition 2019-01-25 14:47:35 -08:00
health_test.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
kv.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
kv_test.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
lock.go
lock_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
operator_keyring.go agent: display messages from serf in cli (#5236) 2019-01-22 21:08:50 +01:00
operator_keyring_test.go
operator_raft.go
operator_raft_test.go
operator_segment.go
prepared_query.go
prepared_query_test.go
raw.go
README.md
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go
status_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
txn.go txn: update existing txn api docs with new operations 2019-01-15 16:54:07 -08:00
txn_test.go Re-add ReadableDuration types to health check definition 2019-01-25 14:47:35 -08:00

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:

package main

import "github.com/hashicorp/consul/api"
import "fmt"

func main() {
	// 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: "REDIS_MAXCLIENTS", Value: []byte("1000")}
	_, err = kv.Put(p, nil)
	if err != nil {
		panic(err)
	}

	// Lookup the pair
	pair, _, err := kv.Get("REDIS_MAXCLIENTS", nil)
	if err != nil {
		panic(err)
	}
	fmt.Printf("KV: %v %s\n", pair.Key, pair.Value)
}

To run this example, start a Consul server:

consul agent -dev

Copy the code above into a file such as main.go.

Install and run. You'll see a key (REDIS_MAXCLIENTS) and value (1000) printed.

$ go get
$ go run main.go
KV: REDIS_MAXCLIENTS 1000

After running the code, you can also view the values in the Consul UI on your local machine at http://localhost:8500/ui/dc1/kv