consul/api
Derek Menteer 50cbc7f6c4
Derekm/release updates (#15383)
* Update changelog with 1.14 notes.

* gomod version bumps for 1.14 release.

* Post-release gomod changes.

* Version bump.
2022-11-15 13:45:26 -06:00
..
watch Backport of Update go version to 1.19 into release/1.14.x (#15139) 2022-10-24 16:12:42 -04:00
.golangci.yml
README.md
acl.go Fix namespace default field names in expanded token output 2022-04-13 16:46:39 -07:00
acl_test.go Backport of Update go version to 1.19 into release/1.14.x (#15139) 2022-10-24 16:12:42 -04:00
agent.go UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -04:00
agent_test.go update config defaults, add docs (#15302) (#15323) 2022-11-10 11:21:31 -06:00
api.go Backport of Allow consul debug on non-ACL consul servers into release/1.14.x (#15167) 2022-10-27 09:26:06 -04:00
api_test.go Use internal server certificate for peering TLS 2022-10-07 09:05:32 -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 Add envoy connection balancing. (#14616) 2022-09-26 11:29:06 -05: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 backport of commit d34e9ed5a8 (#15286) 2022-11-08 09:26:27 -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 Add SourcePeer fields to relevant Intentions types (#13390) 2022-06-08 13:24:10 -04:00
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) (#15323) 2022-11-10 11:21:31 -06:00
connect_intention.go Add SourcePeer fields to relevant Intentions types (#13390) 2022-06-08 13:24:10 -04:00
connect_intention_test.go Support partitions in connect expose cmd 2021-11-12 14:45:32 -07:00
coordinate.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
coordinate_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
debug.go Backport of Allow consul debug on non-ACL consul servers into release/1.14.x (#15167) 2022-10-27 09:26:06 -04:00
debug_test.go
discovery_chain.go xds: ensure that all connect timeout configs can apply equally to tproxy direct dial connections (#12711) 2022-04-07 16:58:21 -05:00
discovery_chain_test.go xds: ensure that all connect timeout configs can apply equally to tproxy direct dial connections (#12711) 2022-04-07 16:58:21 -05:00
event.go
event_test.go
go.mod Derekm/release updates (#15383) 2022-11-15 13:45:26 -06:00
go.sum Remove ability to specify external addresses in GenerateToken endpoint (#14930) 2022-10-19 09:31:36 -07: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
namespace.go remove gogo from acl protobufs 2022-03-28 16:20:56 -04:00
namespace_test.go re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go partitions: various refactors to support partitioning the serf LAN pool (#11568) 2021-11-15 09:51:14 -06:00
operator_keyring_test.go
operator_license.go
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
partition.go Clarify feature name in partition docstring 2021-12-03 17:05:17 -07:00
peering.go Backport of Bring back parameter ServerExternalAddresses in GenerateToken endpoint into release/1.14.x (#15296) 2022-11-08 15:31:17 -06:00
peering_test.go Backport of Bring back parameter ServerExternalAddresses in GenerateToken endpoint into release/1.14.x (#15296) 2022-11-08 15:31:17 -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 [OSS] Remove remaining references to master (#11827) 2022-01-20 12:47:50 +00:00
raw.go
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go
status_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
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

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