open-consul/api
Derek Menteer 1f21364f7c
Consul 1.14 post-release updates (#15382)
* Update changelog with 1.14 notes.

* gomod version bumps for 1.14 release.
2022-11-15 14:22:43 -06:00
..
watch Regenerate files according to 1.19.2 formatter 2022-10-24 16:12:08 -04:00
.golangci.yml
acl.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
acl_test.go Regenerate files according to 1.19.2 formatter 2022-10-24 16:12:08 -04:00
agent.go
agent_test.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
api.go Allow consul debug on non-ACL consul servers (#15155) 2022-10-27 09:25:18 -04:00
api_test.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
catalog.go fix(txn api): missing proxy config in registering proxy service (#14471) 2022-09-02 14:28:05 -04:00
catalog_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
config_entry.go config entry: hardcode proxy-defaults name as global (#14833) 2022-10-25 10:55:15 -07:00
config_entry_discoverychain.go Add the ability to retry on reset connection to service-routers (#12890) 2022-10-05 13:06:44 -04:00
config_entry_discoverychain_test.go Add the ability to retry on reset connection to service-routers (#12890) 2022-10-05 13:06:44 -04:00
config_entry_exports.go Update api package exported services comment. (#15285) 2022-11-08 09:26:07 -05:00
config_entry_exports_test.go Rename PeerName to Peer on prepared queries and exported services (#14854) 2022-10-04 14:46:15 -04:00
config_entry_gateways.go feat(ingress gateway: support configuring limits in ingress-gateway c… (#14749) 2022-09-28 14:56:46 -04:00
config_entry_gateways_test.go feat(ingress gateway: support configuring limits in ingress-gateway c… (#14749) 2022-09-28 14:56:46 -04:00
config_entry_intentions.go
config_entry_intentions_test.go
config_entry_mesh.go feat: add PeerThroughMeshGateways to mesh config 2022-09-13 17:19:54 -04:00
config_entry_test.go Add envoy connection balancing. (#14616) 2022-09-26 11:29:06 -05:00
connect.go
connect_ca.go
connect_ca_test.go update config defaults, add docs (#15302) 2022-11-09 09:29:55 -08:00
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
debug.go Allow consul debug on non-ACL consul servers (#15155) 2022-10-27 09:25:18 -04:00
debug_test.go
discovery_chain.go
discovery_chain_test.go
event.go
event_test.go
go.mod Consul 1.14 post-release updates (#15382) 2022-11-15 14:22:43 -06:00
go.sum removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
health.go Merge pull request #13388 from deblasis/feature/health-checks_windows_service 2022-10-17 09:26:19 -04:00
health_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
kv.go
kv_test.go
lock.go
lock_test.go
mock_api_test.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
namespace.go
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go
operator_keyring_test.go
operator_license.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
operator_raft.go Leadership transfer cmd (#14132) 2022-11-14 15:35:12 -05:00
operator_raft_test.go Leadership transfer cmd (#14132) 2022-11-14 15:35:12 -05:00
operator_segment.go
oss_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
partition.go
peering.go Bring back parameter ServerExternalAddresses in GenerateToken endpoint (#15267) 2022-11-08 14:55:18 -06:00
peering_test.go Bring back parameter ServerExternalAddresses in GenerateToken endpoint (#15267) 2022-11-08 14:55:18 -06:00
prepared_query.go Rename PeerName to Peer on prepared queries and exported services (#14854) 2022-10-04 14:46:15 -04:00
prepared_query_test.go
raw.go
README.md
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go Add kv txn get-not-exists operation. 2022-09-06 10:28:59 -05:00
txn_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04: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