consul/api
Kyle Havlovitz 658e6a97bb Merge pull request #9672 from hashicorp/ca-force-skip-xc
connect/ca: Allow ForceWithoutCrossSigning for all providers
2021-04-20 15:41:32 -05:00
..
watch Merge pull request #8404 from hashicorp/dnephin/remove-log-output-field 2020-08-05 18:32:16 +00:00
.golangci.yml ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md
acl.go Merge pull request #8169 from hashicorp/config-entry-ns 2020-06-23 11:44:57 -06:00
acl_test.go Add PolicyReadByName for API (#6615) 2020-03-25 10:34:24 -04:00
agent.go Add helpers to the API client to help with getting information from `AgentMember` tags (#8575) 2020-08-27 15:01:18 +00:00
agent_test.go Add helpers to the API client to help with getting information from `AgentMember` tags (#8575) 2020-08-27 15:01:18 +00:00
api.go api: create fresh http client for unix sockets (#8602) 2020-09-06 16:28:56 +00:00
api_test.go Merge pull request #7948 from hashicorp/dnephin/buffer-test-logs 2020-07-21 19:22:29 +00:00
catalog.go Add api mod support for /catalog/gateway-services (#8278) 2020-07-10 19:02:09 +00:00
catalog_test.go Add api mod support for /catalog/gateway-services (#8278) 2020-07-10 19:02:09 +00:00
config_entry.go connect: all config entries pick up a meta field (#8596) 2020-09-02 19:22:37 +00:00
config_entry_discoverychain.go connect: all config entries pick up a meta field (#8596) 2020-09-02 19:22:37 +00:00
config_entry_discoverychain_test.go
config_entry_gateways.go connect: all config entries pick up a meta field (#8596) 2020-09-02 19:22:37 +00:00
config_entry_gateways_test.go Merge pull request #8034 from hashicorp/dnephin/add-linter-staticcheck-4 2020-08-05 13:37:35 -04:00
config_entry_test.go connect: all config entries pick up a meta field (#8596) 2020-09-02 19:22:37 +00:00
connect.go
connect_ca.go Merge pull request #9672 from hashicorp/ca-force-skip-xc 2021-04-20 15:41:32 -05:00
connect_ca_test.go ci: Add staticcheck and fix most errors 2020-06-01 10:40:04 -05:00
connect_intention.go Replace whitelist/blacklist terminology with allowlist/denylist (#7971) 2020-06-01 10:40:14 -05:00
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
discovery_chain_test.go
event.go
event_test.go
go.mod api: bump consul/api to v1.6.0 and consul/sdk to v0.6.0 (#8460) 2020-08-07 21:26:45 +00:00
go.sum gossip: Avoid issue where two unique leave events for the same node could lead to infinite rebroadcast storms (#8343) 2020-07-21 20:49:09 +00:00
health.go Move ingress param to a new endpoint (#8081) 2020-06-10 18:07:41 +00:00
health_test.go Move ingress param to a new endpoint (#8081) 2020-06-10 18:07:41 +00:00
kv.go
kv_test.go
lock.go Merge pull request #8034 from hashicorp/dnephin/add-linter-staticcheck-4 2020-08-05 13:37:35 -04:00
lock_test.go
namespace.go
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go add primary keys to list keyring (#8522) 2020-08-18 07:51:22 +00:00
operator_keyring_test.go
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
operator_segment.go
oss_test.go
prepared_query.go Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
prepared_query_test.go
raw.go
semaphore.go
semaphore_test.go Merge pull request #8034 from hashicorp/dnephin/add-linter-staticcheck-4 2020-08-05 13:37:35 -04:00
session.go
session_test.go Merge pull request #8034 from hashicorp/dnephin/add-linter-staticcheck-4 2020-08-05 13:37:35 -04:00
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