consul/api
cskh 527ebd068a
fix: missing MaxInboundConnections field in service-defaults config entry (#14072)
* fix:  missing max_inbound_connections field in merge config
2022-08-19 14:11:21 -04:00
..
watch
.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 syncing changes back from enterprise (#12701) 2022-04-05 15:46:56 -05:00
agent.go UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -04:00
agent_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
api.go Add support for merge-central-config query param (#13001) 2022-05-25 13:20:17 -07:00
api_test.go api: add the ability to specify a path prefix (#12914) 2022-05-19 16:07:59 -07:00
catalog.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
catalog_test.go test: fix flaky test TestAPI_CatalogNodes (#13779) 2022-07-15 13:24:22 -05:00
config_entry.go fix: missing MaxInboundConnections field in service-defaults config entry (#14072) 2022-08-19 14:11:21 -04:00
config_entry_discoverychain.go Add `Targets` field to service resolver failovers. (#14162) 2022-08-15 09:20:25 -04:00
config_entry_discoverychain_test.go Add `Targets` field to service resolver failovers. (#14162) 2022-08-15 09:20:25 -04:00
config_entry_exports.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
config_entry_exports_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
config_entry_gateways.go
config_entry_gateways_test.go
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 Fixup missed config entry 2022-05-04 08:50:59 -07:00
config_entry_test.go fix: missing MaxInboundConnections field in service-defaults config entry (#14072) 2022-08-19 14:11:21 -04:00
connect.go
connect_ca.go
connect_ca_test.go bulk rewrite using this script 2022-01-20 10:46:23 -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
coordinate.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
coordinate_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
debug.go
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 update generate token endpoint to take external addresses (#13844) 2022-07-21 14:56:11 -07:00
go.sum update generate token endpoint to take external addresses (#13844) 2022-07-21 14:56:11 -07:00
health.go UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -04:00
health_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06: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
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go
operator_keyring_test.go
operator_license.go
operator_raft.go
operator_raft_test.go
operator_segment.go
oss.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
partition.go
peering.go Add ACL enforcement to peering endpoints 2022-07-25 09:34:29 -06:00
peering_test.go Implement/Utilize secrets for Peering Replication Stream (#13977) 2022-08-01 10:33:18 -04:00
prepared_query.go Add Cluster Peering Failover Support to Prepared Queries (#13835) 2022-07-22 09:14:43 -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
txn_test.go UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -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