open-consul/api
2020-06-09 12:11:47 -05:00
..
watch
.golangci.yml
acl.go acl: allow auth methods created in the primary datacenter to optionally create global tokens (#7899) 2020-06-01 11:44:47 -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 acl: remove the deprecated acl_enforce_version_8 option (#7991) 2020-05-29 16:16:03 -05:00
catalog.go
catalog_test.go
config_entry.go Add alias struct tags for new decode hook 2020-05-27 16:24:47 -04:00
config_entry_discoverychain.go Add alias struct tags for new decode hook 2020-05-27 16:24:47 -04:00
config_entry_discoverychain_test.go
config_entry_gateways.go Add alias struct tags for new decode hook 2020-05-27 16:24:47 -04:00
config_entry_gateways_test.go Merge pull request #7759 from hashicorp/ingress/tls-hosts 2020-05-11 09:18:43 -07:00
config_entry_test.go Add TLS field to ingress API structs 2020-05-06 15:12:02 -05:00
connect.go
connect_ca.go
connect_ca_test.go ci: Add staticcheck and fix most errors 2020-05-28 11:59:58 -04:00
connect_intention.go Replace whitelist/blacklist terminology with allowlist/denylist (#7971) 2020-05-29 14:19:16 -04:00
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 api: update api module with health.Ingress() method 2020-06-09 12:11:47 -05:00
health_test.go api: update api module with health.Ingress() method 2020-06-09 12:11:47 -05:00
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 Add unconvert linter 2020-05-12 13:47:25 -04:00
operator_raft_test.go
operator_segment.go
oss_test.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

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