tree: f5669e5535ba0a83a1a60023b8bdc338da312d57 [path history] [tgz]
  1. LICENSE
  2. README.md
  3. acl.go
  4. agent.go
  5. api.go
  6. catalog.go
  7. config_entry.go
  8. config_entry_discoverychain.go
  9. connect.go
  10. connect_ca.go
  11. connect_intention.go
  12. coordinate.go
  13. debug.go
  14. discovery_chain.go
  15. event.go
  16. go.mod
  17. go.sum
  18. health.go
  19. kv.go
  20. lock.go
  21. operator.go
  22. operator_area.go
  23. operator_autopilot.go
  24. operator_keyring.go
  25. operator_license.go
  26. operator_raft.go
  27. operator_segment.go
  28. prepared_query.go
  29. raw.go
  30. semaphore.go
  31. session.go
  32. snapshot.go
  33. status.go
  34. txn.go
vendor/github.com/hashicorp/consul/api/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:

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