open-consul/api
Daniel Nephin 2e0f750f1a Add unconvert linter
To find unnecessary type convertions
2020-05-12 13:47:25 -04:00
..
watch Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
.golangci.yml ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md Copy-and-paste Go client example (#4448) 2018-07-30 12:48:19 +01:00
acl.go acl: add auth method for JWTs (#7846) 2020-05-11 20:59:29 -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 Allow users to configure either unstructured or JSON logging (#7130) 2020-01-28 17:50:41 -06:00
catalog.go Add the v1/catalog/node-services/:node endpoint (#7115) 2020-01-24 09:27:25 -05:00
catalog_test.go Add the v1/catalog/node-services/:node endpoint (#7115) 2020-01-24 09:27:25 -05:00
config_entry.go Add config entry for terminating gateways (#7545) 2020-03-31 13:27:32 -06:00
config_entry_discoverychain.go Updates to Config Entries and Connect for Namespaces (#7116) 2020-01-24 10:04:58 -05:00
config_entry_discoverychain_test.go Updates to Config Entries and Connect for Namespaces (#7116) 2020-01-24 10:04:58 -05:00
config_entry_gateways.go Add TLS field to ingress API structs 2020-05-06 15:12:02 -05: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 api: fix up some comments and rename IssuedCert to LeafCert 2018-06-14 09:41:56 -07:00
connect_ca.go connect: check if intermediate cert needs to be renewed. (#6835) 2020-01-17 23:27:13 +01:00
connect_ca_test.go connect: check if intermediate cert needs to be renewed. (#6835) 2020-01-17 23:27:13 +01:00
connect_intention.go Implement Mesh Gateways 2019-07-01 16:28:30 -04:00
connect_intention_test.go Implement Mesh Gateways 2019-07-01 16:28:30 -04:00
coordinate.go docs: Miscellaneous docs cleanup (#6742) 2019-11-05 20:34:46 -08:00
coordinate_test.go Merge pull request #5376 from hashicorp/fix-tests 2019-04-04 17:09:32 -04:00
debug.go New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
debug_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
discovery_chain.go Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
discovery_chain_test.go Fix TestAPI_DiscoveryChain_Get flake (#7082) 2020-01-20 14:56:56 +00:00
event.go Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
event_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
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 Add unconvert linter 2020-05-12 13:47:25 -04:00
health_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
kv.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06:00
kv_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
lock.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
lock_test.go Merge Consul OSS branch 'master' at commit 95dbb7f2f1b9fc3528a16335201e2324f1b388bd 2019-07-17 02:00:21 +00:00
namespace.go Add kv meta to namespaces api module (#6958) 2019-12-17 10:28:51 -07:00
namespace_test.go Add kv meta to namespaces api module (#6958) 2019-12-17 10:28:51 -07: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 Use encoding/json as JSON decoder instead of mapstructure (#6680) 2019-10-29 11:13:36 -07:00
operator_autopilot_test.go Update retries that weren't using retry.R (#6146) 2019-07-16 14:47:45 -06:00
operator_keyring.go agent: display messages from serf in cli (#5236) 2019-01-22 21:08:50 +01:00
operator_keyring_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
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 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
oss_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
prepared_query.go Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
prepared_query_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
raw.go api: Refactoring into shared write logic 2015-02-18 15:15:02 -08:00
semaphore.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
semaphore_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
session.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06:00
session_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
snapshot.go Adds support for snapshots and restores. (#2396) 2016-10-25 19:20:24 -07:00
snapshot_test.go add serf check to TestAPI_Snapshot 2019-02-22 17:34:45 -05: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 Updates to the Txn API for namespaces (#7172) 2020-01-30 13:12:26 -05:00
txn_test.go Add support for dual stack IPv4/IPv6 network (#6640) 2020-01-17 09:54:17 -05: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