open-consul/api
freddygv 224f486aef Update namespaces subject-verb agreement 2020-06-23 10:57:30 -06:00
..
watch Enable gofmt simplify 2020-06-16 13:21:11 -04:00
.golangci.yml ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md
acl.go Update namespaces subject-verb agreement 2020-06-23 10:57:30 -06:00
acl_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
agent.go Add AgentMemberStatus const (#8110) 2020-06-22 12:18:45 -05:00
agent_test.go Merge pull request #8034 from hashicorp/dnephin/add-linter-staticcheck-4 2020-06-17 12:16:02 -04: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 Enable gofmt simplify 2020-06-16 13:21:11 -04: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 Enable gofmt simplify 2020-06-16 13:21:11 -04:00
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 ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
config_entry_test.go Merge pull request #8034 from hashicorp/dnephin/add-linter-staticcheck-4 2020-06-17 12:16:02 -04: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 intentions: fix a bug in Intention.SetHash 2020-06-05 14:51:43 -04:00
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go
discovery_chain_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
event.go
event_test.go
go.mod wan federation via mesh gateways (#6884) 2020-03-09 15:59:02 -05:00
go.sum wan federation via mesh gateways (#6884) 2020-03-09 15:59:02 -05:00
health.go Move ingress param to a new endpoint (#8081) 2020-06-10 13:07:15 -05:00
health_test.go Move ingress param to a new endpoint (#8081) 2020-06-10 13:07:15 -05:00
kv.go
kv_test.go ci: Enabled SA2002 staticcheck check 2020-06-05 17:50:11 -04:00
lock.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
lock_test.go ci: Enabled SA2002 staticcheck check 2020-06-05 17:50:11 -04:00
namespace.go
namespace_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
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
semaphore.go
semaphore_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
session.go
session_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go
txn_test.go

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