open-consul/api
freddygv 33af8dab9a Resolve conflicts against master 2020-09-11 18:41:58 -06:00
..
watch api: Use a Logger instead of an io.Writer in api.Watch 2020-08-05 13:25:08 -04:00
.golangci.yml
README.md
acl.go
acl_test.go
agent.go Add helpers to the API client to help with getting information from `AgentMember` tags (#8575) 2020-08-27 11:00:48 -04:00
agent_test.go Add helpers to the API client to help with getting information from `AgentMember` tags (#8575) 2020-08-27 11:00:48 -04:00
api.go api: create fresh http client for unix sockets (#8602) 2020-09-06 12:27:39 -04:00
api_test.go testing: Remove all the defer os.Removeall 2020-08-14 19:58:53 -04:00
catalog.go
catalog_test.go
config_entry.go connect: all config entries pick up a meta field (#8596) 2020-09-02 14:10:25 -05:00
config_entry_discoverychain.go Resolve conflicts against master 2020-09-11 18:41:58 -06:00
config_entry_discoverychain_test.go Add session flag to cookie config 2020-09-11 18:34:03 -06:00
config_entry_gateways.go connect: all config entries pick up a meta field (#8596) 2020-09-02 14:10:25 -05:00
config_entry_gateways_test.go
config_entry_test.go Resolve conflicts against master 2020-09-11 18:41:58 -06:00
connect.go
connect_ca.go
connect_ca_test.go
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go Ensure resolver node with LB isn't considered default 2020-09-03 08:55:57 -06:00
discovery_chain_test.go
event.go
event_test.go
go.mod api: bump consul/api to v1.6.0 and consul/sdk to v0.6.0 (#8460) 2020-08-07 17:26:05 -04:00
go.sum
health.go
health_test.go
kv.go
kv_test.go
lock.go Make LockDelay configurable in api locks (#8621) 2020-09-04 13:38:26 -06:00
lock_test.go
namespace.go
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go add primary keys to list keyring (#8522) 2020-08-18 09:50:24 +02:00
operator_keyring_test.go
operator_license.go
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go
prepared_query.go
prepared_query_test.go
raw.go
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go api: restore Leader() and Peers() to avoid breaking function signatures (#8395) 2020-07-29 12:09:15 -04:00
status_test.go api: restore Leader() and Peers() to avoid breaking function signatures (#8395) 2020-07-29 12:09:15 -04:00
txn.go
txn_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:

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