open-consul/api
2020-05-06 13:48:04 -05:00
..
watch
.golangci.yml ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
acl.go acl: oss plumbing to support auth method namespace rules in enterprise (#7794) 2020-05-06 13:48:04 -05:00
acl_test.go Add PolicyReadByName for API (#6615) 2020-03-25 10:34:24 -04:00
agent.go Add support for ingress-gateway in CLI command (#7618) 2020-04-14 09:48:02 -05:00
agent_test.go tests: fixed unstable test TestAPI_AgentMonitor (#7561) 2020-04-01 09:47:57 +02:00
api.go Step 3: fix a bug in api.NewClient and fix the tests 2020-04-07 18:02:56 -04:00
api_test.go
catalog.go
catalog_test.go
config_entry.go Add config entry for terminating gateways (#7545) 2020-03-31 13:27:32 -06:00
config_entry_discoverychain.go
config_entry_discoverychain_test.go
config_entry_gateways.go TLS Origination for Terminating Gateways (#7671) 2020-04-27 16:25:37 -06:00
config_entry_gateways_test.go TLS Origination for Terminating Gateways (#7671) 2020-04-27 16:25:37 -06:00
config_entry_test.go TLS Origination for Terminating Gateways (#7671) 2020-04-27 16:25:37 -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 Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
discovery_chain_test.go
event.go
event_test.go
go.mod wan federation via mesh gateways (#6884) 2020-03-09 15:59:02 -05:00
go.sum wan federation via mesh gateways (#6884) 2020-03-09 15:59:02 -05:00
health.go feat: support sending body in HTTP checks (#6602) 2020-02-10 09:27:12 -07:00
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
namespace.go
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go
operator_keyring_test.go
operator_license.go Update API module to include the licensed modules in its output (#7661) 2020-04-17 13:39:27 -04:00
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go
prepared_query.go Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
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
txn.go
txn_test.go

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