open-consul/api
2019-01-15 16:54:07 -08:00
..
acl.go Adds documentation for the new ACL APIs (#4851) 2018-10-31 15:11:51 -07:00
acl_test.go New ACL API Tests (#4848) 2018-10-25 11:09:46 -04:00
agent.go New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
agent_test.go New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
api.go Remove wrong space character (#4910) 2018-11-06 22:34:36 +01:00
api_test.go New ACLs (#4791) 2018-10-19 12:04:07 -04:00
catalog.go Add support for multiple checks in Consul Client (#4849) 2018-10-29 09:39:25 -07:00
catalog_test.go Add support for multiple checks in Consul Client (#4849) 2018-10-29 09:39:25 -07:00
connect.go api: fix up some comments and rename IssuedCert to LeafCert 2018-06-14 09:41:56 -07:00
connect_ca.go connect/ca: add configurable leaf cert TTL 2018-07-16 13:33:37 -07:00
connect_ca_test.go Merge pull request #4400 from hashicorp/leaf-cert-ttl 2018-07-25 17:53:25 -07:00
connect_intention.go agent: 400 error on invalid UUID format, api handles errors properly 2018-06-27 07:40:06 +02:00
connect_intention_test.go agent: 400 error on invalid UUID format, api handles errors properly 2018-06-27 07:40:06 +02:00
coordinate.go
coordinate_test.go
debug.go New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
debug_test.go New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
event.go
event_test.go
health.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
health_test.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
kv.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
kv_test.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
lock.go Fix lock and semaphore timeouts 2018-07-06 10:55:25 +01:00
lock_test.go Improve resilience of api pkg tests (#4676) 2018-09-18 17:47:01 +01:00
operator.go
operator_area.go Remove operator_area note from godoc overview (#4603) 2018-08-28 16:02:24 -04:00
operator_autopilot.go
operator_autopilot_test.go BUGFIX: Unit test relying on WaitForLeader() did not work due to wrong test (#4472) 2018-08-06 19:46:09 -04:00
operator_keyring.go
operator_keyring_test.go
operator_raft.go
operator_raft_test.go
operator_segment.go
prepared_query.go api: change Connect to a query option 2018-06-25 12:24:14 -07:00
prepared_query_test.go
raw.go
README.md Copy-and-paste Go client example (#4448) 2018-07-30 12:48:19 +01:00
semaphore.go Fix lock and semaphore timeouts 2018-07-06 10:55:25 +01:00
semaphore_test.go Improve resilience of api pkg tests (#4676) 2018-09-18 17:47:01 +01:00
session.go
session_test.go Improve resilience of api pkg tests (#4676) 2018-09-18 17:47:01 +01:00
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go txn: update existing txn api docs with new operations 2019-01-15 16:54:07 -08:00
txn_test.go txn: update existing txn api docs with new operations 2019-01-15 16:54:07 -08: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