consul/api
R.B. Boyer 4db8b78854
connect: update centralized upstreams representation in service-defaults (#10015)
2021-04-15 14:21:44 -05:00
..
watch api: Use a Logger instead of an io.Writer in api.Watch 2020-08-05 13:25:08 -04:00
.golangci.yml
README.md
acl.go Add fields to the /acl/auth-methods endpoint. (#9741) 2021-02-17 08:16:57 -08:00
acl_test.go Add fields to the /acl/auth-methods endpoint. (#9741) 2021-02-17 08:16:57 -08:00
agent.go Convert new tproxy structs in api module into ptrs 2021-04-13 12:44:25 -06:00
agent_test.go Replace TransparentProxy bool with ProxyMode 2021-04-12 09:35:14 -06:00
api.go Move header methods from config to client 2021-01-20 01:30:54 +00:00
api_test.go Move header methods from config to client 2021-01-20 01:30:54 +00:00
catalog.go
catalog_test.go Convert new tproxy structs in api module into ptrs 2021-04-13 12:44:25 -06:00
config_entry.go connect: update centralized upstreams representation in service-defaults (#10015) 2021-04-15 14:21:44 -05:00
config_entry_cluster.go connect: add toggle to globally disable wildcard outbound network access when transparent proxy is enabled (#9973) 2021-04-06 13:19:59 -05:00
config_entry_discoverychain.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_discoverychain_test.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_gateways.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_gateways_test.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_intentions.go connect: support defining intentions using layer 7 criteria (#8839) 2020-10-06 17:09:13 -05:00
config_entry_intentions_test.go connect: intentions are now managed as a new config entry kind "service-intentions" (#8834) 2020-10-06 13:24:05 -05:00
config_entry_test.go connect: update centralized upstreams representation in service-defaults (#10015) 2021-04-15 14:21:44 -05:00
connect.go
connect_ca.go connect/ca: Allow ForceWithoutCrossSigning for all providers 2021-01-29 13:38:11 -08:00
connect_ca_test.go
connect_intention.go connect: support defining intentions using layer 7 criteria (#8839) 2020-10-06 17:09:13 -05:00
connect_intention_test.go api: unflake some intention-related api tests (#8857) 2020-10-07 13:32:53 -05:00
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go Ensure resolver node with LB isn't considered default 2020-09-03 08:55:57 -06:00
discovery_chain_test.go
event.go
event_test.go
go.mod Merge pull request #9270 from hashicorp/release/1.9.0 2020-11-24 17:36:47 -05:00
go.sum Update memberlist to v0.2.3 2021-03-24 18:20:19 -04:00
health.go Add support for configuring TLS ServerName for health checks 2021-03-16 18:16:44 -04:00
health_test.go
kv.go
kv_test.go
lock.go Make LockDelay configurable in api locks (#8621) 2020-09-04 13:38:26 -06:00
lock_test.go
mock_api_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
namespace.go upstream some differences from enterprise (#8902) 2020-10-09 09:42:53 -05:00
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
operator_autopilot_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
operator_keyring.go add primary keys to list keyring (#8522) 2020-08-18 09:50:24 +02:00
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
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