open-consul/api
R.B. Boyer 91e78e00c7
fix typos reported by golangci-lint:misspell (#5434)
2019-03-06 11:13:28 -06:00
..
README.md Copy-and-paste Go client example (#4448) 2018-07-30 12:48:19 +01:00
acl.go Adds documentation for the new ACL APIs (#4851) 2018-10-31 15:11:51 -07:00
acl_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
agent.go ACL Token Persistence and Reloading (#5328) 2019-02-27 14:28:31 -05:00
agent_test.go ACL Token Persistence and Reloading (#5328) 2019-02-27 14:28:31 -05:00
api.go fix typos reported by golangci-lint:misspell (#5434) 2019-03-06 11:13:28 -06: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 [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08: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: tame thundering herd of CSRs on CA rotation (#5228) 2019-01-22 17:19:36 +00: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 Merge branch 'coordinate-node-endpoint' of github.com:hashicorp/consul into esm-changes 2017-10-26 19:20:24 -07:00
coordinate_test.go Move check definition to a sub-struct 2017-11-01 14:54:46 -07:00
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 Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
event_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
health.go Fall back to using old fields when marshaling 2019-01-28 08:47:26 -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 Moves operator sub-functions into their own files. 2017-03-30 12:35:50 -07:00
operator_area.go Remove operator_area note from godoc overview (#4603) 2018-08-28 16:02:24 -04:00
operator_autopilot.go Simplify string(buf.Bytes()) to buf.String() (#3590) 2017-10-18 13:26:09 -07:00
operator_autopilot_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
operator_keyring.go agent: display messages from serf in cli (#5236) 2019-01-22 21:08:50 +01:00
operator_keyring_test.go New config parser, HCL support, multiple bind addrs (#3480) 2017-09-25 11:40:42 -07:00
operator_raft.go Move Raft protocol version for list peers end point to server side, fix unit tests. This fixes #3449 2017-09-26 09:35:39 -05:00
operator_raft_test.go api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_segment.go Change segment list endpoint in docs/client api 2017-09-01 12:40:07 -07:00
prepared_query.go Improve Connect with Prepared Queries (#5291) 2019-02-04 09:36:51 -05:00
prepared_query_test.go Improve Connect with Prepared Queries (#5291) 2019-02-04 09:36:51 -05:00
raw.go api: Refactoring into shared write logic 2015-02-18 15:15:02 -08: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 Expands and rework context support in the API client. (#3273) 2017-07-14 17:30:08 -07:00
session_test.go Improve resilience of api pkg tests (#4676) 2018-09-18 17:47:01 +01:00
snapshot.go Adds support for snapshots and restores. (#2396) 2016-10-25 19:20:24 -07:00
snapshot_test.go api: refactor: prefix all API tests with API_ 2017-07-07 09:22:34 +02:00
status.go Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
status_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
txn.go txn: update existing txn api docs with new operations 2019-01-15 16:54:07 -08:00
txn_test.go Re-add ReadableDuration types to health check definition 2019-01-25 14:47:35 -08:00

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