open-consul/api
Fouad Zaryouh b33cf06cf7
api: add replace-existing-checks param to the api package (#7136)
2020-02-03 10:11:40 +01:00
..
watch Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
README.md
acl.go
acl_test.go
agent.go api: add replace-existing-checks param to the api package (#7136) 2020-02-03 10:11:40 +01:00
agent_test.go api: add replace-existing-checks param to the api package (#7136) 2020-02-03 10:11:40 +01:00
api.go Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
api_test.go Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
catalog.go Add the v1/catalog/node-services/:node endpoint (#7115) 2020-01-24 09:27:25 -05:00
catalog_test.go Add the v1/catalog/node-services/:node endpoint (#7115) 2020-01-24 09:27:25 -05:00
config_entry.go Updates to Config Entries and Connect for Namespaces (#7116) 2020-01-24 10:04:58 -05:00
config_entry_discoverychain.go Updates to Config Entries and Connect for Namespaces (#7116) 2020-01-24 10:04:58 -05:00
config_entry_discoverychain_test.go Updates to Config Entries and Connect for Namespaces (#7116) 2020-01-24 10:04:58 -05:00
config_entry_test.go
connect.go
connect_ca.go connect: check if intermediate cert needs to be renewed. (#6835) 2020-01-17 23:27:13 +01:00
connect_ca_test.go connect: check if intermediate cert needs to be renewed. (#6835) 2020-01-17 23:27:13 +01:00
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go
discovery_chain_test.go Fix TestAPI_DiscoveryChain_Get flake (#7082) 2020-01-20 14:56:56 +00:00
event.go
event_test.go
go.mod Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
go.sum Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
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 Updates to the Txn API for namespaces (#7172) 2020-01-30 13:12:26 -05:00
txn_test.go Add support for dual stack IPv4/IPv6 network (#6640) 2020-01-17 09:54:17 -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