open-consul/api
2021-09-15 17:25:21 -06:00
..
watch
.golangci.yml
acl.go
acl_test.go acl-tokens table partitioning (#11020) 2021-09-13 16:53:09 -04:00
agent.go Add failures_before_warning to checks (#10969) 2021-09-14 12:47:52 -04:00
agent_test.go agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
api.go Fixup api config and Envoy test 2021-09-15 17:25:21 -06:00
api_test.go
catalog.go
catalog_test.go
config_entry.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_cluster.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_discoverychain.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_discoverychain_test.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_gateways.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_gateways_test.go Add Changelog entry and api package support for HTTP Header manip 2021-09-10 21:09:24 +01:00
config_entry_intentions.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_intentions_test.go
config_entry_test.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
connect.go
connect_ca.go
connect_ca_test.go
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
debug.go debug: restore cancel on SigInt 2021-08-18 12:29:34 -04:00
debug_test.go
discovery_chain.go
discovery_chain_test.go partition dicovery chains (#10983) 2021-09-07 16:29:32 -04:00
event.go
event_test.go
go.mod
go.sum
health.go
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
mock_api_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 Revert early out errors in license API (#10952) 2021-08-31 10:36:35 -06:00
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go
partition.go Sync partitions support in api module (#10938) 2021-08-26 18:40:34 -06:00
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

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