open-consul/api
Matt Keeler 5c56aab3be
Change how namespaces are specified for the CLI (#6960)
2019-12-18 11:06:39 -05:00
..
watch agent: fix watch event behavior (#5265) 2019-12-10 12:02:21 +01:00
README.md
acl.go
acl_test.go
agent.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
agent_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
api.go Change how namespaces are specified for the CLI (#6960) 2019-12-18 11:06:39 -05:00
api_test.go
catalog.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
catalog_test.go
config_entry.go
config_entry_discoverychain.go
config_entry_discoverychain_test.go
config_entry_test.go
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
discovery_chain_test.go
event.go
event_test.go
go.mod
go.sum
health.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
health_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
kv.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06:00
kv_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
lock.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
lock_test.go
namespace.go Add kv meta to namespaces api module (#6958) 2019-12-17 10:28:51 -07:00
namespace_test.go Add kv meta to namespaces api module (#6958) 2019-12-17 10:28:51 -07:00
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go
operator_keyring_test.go
operator_license.go
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
prepared_query.go
prepared_query_test.go
raw.go
semaphore.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
semaphore_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
session.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06:00
session_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06:00
txn_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00

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