open-consul/api
2019-07-17 15:43:30 -04:00
..
watch More flaky test fixes (#6151) 2019-07-17 09:33:38 -06:00
acl.go
acl_test.go Update retries that weren't using retry.R (#6146) 2019-07-16 14:47:45 -06:00
agent.go Fix some tests that I broke when refactoring the ConfigSnapshot (#6051) 2019-07-01 19:47:58 -04:00
agent_test.go Implement Mesh Gateways 2019-07-01 16:28:30 -04:00
api.go api: update link to agent caching in comments (#5935) 2019-06-13 23:56:19 +02:00
api_test.go Flaky test overhaul (#6100) 2019-07-12 09:52:26 -06:00
catalog.go Add tagged addresses for services (#5965) 2019-06-17 10:51:50 -04:00
catalog_test.go Update retries that weren't using retry.R (#6146) 2019-07-16 14:47:45 -06:00
config_entry.go Implement Mesh Gateways 2019-07-01 16:28:30 -04:00
config_entry_discoverychain.go do some initial config entry graph validation during writes (#6047) 2019-07-01 15:23:36 -05:00
config_entry_discoverychain_test.go do some initial config entry graph validation during writes (#6047) 2019-07-01 15:23:36 -05:00
config_entry_test.go do some initial config entry graph validation during writes (#6047) 2019-07-01 15:23:36 -05:00
connect.go
connect_ca.go
connect_ca_test.go
connect_intention.go Implement Mesh Gateways 2019-07-01 16:28:30 -04:00
connect_intention_test.go Implement Mesh Gateways 2019-07-01 16:28:30 -04:00
coordinate.go
coordinate_test.go
debug.go
debug_test.go
event.go
event_test.go
go.mod
go.sum api: go mod tidy 2019-05-08 13:26:07 -05:00
health.go
health_test.go Fix some retries in api pkg (#6124) 2019-07-12 12:57:41 -06:00
kv.go
kv_test.go
lock.go
lock_test.go Merge Consul OSS branch 'master' at commit 95dbb7f2f1b9fc3528a16335201e2324f1b388bd 2019-07-17 02:00:21 +00:00
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go Update retries that weren't using retry.R (#6146) 2019-07-16 14:47:45 -06:00
operator_keyring.go
operator_keyring_test.go
operator_raft.go
operator_raft_test.go
operator_segment.go
prepared_query.go
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 More flaky test fixes (#6151) 2019-07-17 09:33:38 -06:00

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