consul/api
spooner c34b088583
Added QueryOptions for status api (#7818)
* Added QueryOptions & Tests for status api
2020-07-28 12:26:50 -04:00
..
watch Enable gofmt simplify 2020-06-16 13:21:11 -04:00
.golangci.yml
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 api/agent: enable setting SuccessBeforePassing and FailuresBeforeCritical in API (#7949) 2020-06-29 14:52:35 +02: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
api_test.go testutil: NewLogBuffer - buffer logs until a test fails 2020-07-21 12:50:40 -04:00
catalog.go Add api mod support for /catalog/gateway-services (#8278) 2020-07-10 13:01:45 -06:00
catalog_test.go Add api mod support for /catalog/gateway-services (#8278) 2020-07-10 13:01:45 -06:00
config_entry.go
config_entry_discoverychain.go
config_entry_discoverychain_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
config_entry_gateways.go
config_entry_gateways_test.go
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
connect_intention.go connect: various changes to make namespaces for intentions work more like for other subsystems (#8194) 2020-06-26 16:59:15 -05:00
connect_intention_test.go connect: various changes to make namespaces for intentions work more like for other subsystems (#8194) 2020-06-26 16:59:15 -05:00
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 gossip: Avoid issue where two unique leave events for the same node could lead to infinite rebroadcast storms (#8343) 2020-07-21 15:48:10 -05:00
go.sum gossip: Avoid issue where two unique leave events for the same node could lead to infinite rebroadcast storms (#8343) 2020-07-21 15:48:10 -05:00
health.go
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
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
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go
prepared_query.go
prepared_query_test.go
raw.go
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go Added QueryOptions for status api (#7818) 2020-07-28 12:26:50 -04:00
status_test.go Added QueryOptions for status api (#7818) 2020-07-28 12:26:50 -04:00
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