You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
consul/api
Freddy 9eb1867fbb
Terminating gateway discovery (#7571)
5 years ago
..
watch Allow users to configure either unstructured or JSON logging (#7130) 5 years ago
.golangci.yml ci: Use golangci-lint for linting 5 years ago
README.md
acl.go Add PolicyReadByName for API (#6615) 5 years ago
acl_test.go Add PolicyReadByName for API (#6615) 5 years ago
agent.go Enable CLI to register terminating gateways (#7500) 5 years ago
agent_test.go tests: fixed unstable test TestAPI_AgentMonitor (#7561) 5 years ago
api.go Allow users to configure either unstructured or JSON logging (#7130) 5 years ago
api_test.go Allow users to configure either unstructured or JSON logging (#7130) 5 years ago
catalog.go
catalog_test.go
config_entry.go Add config entry for terminating gateways (#7545) 5 years ago
config_entry_discoverychain.go
config_entry_discoverychain_test.go
config_entry_gateways.go Add config entry for terminating gateways (#7545) 5 years ago
config_entry_gateways_test.go Terminating gateway discovery (#7571) 5 years ago
config_entry_test.go Add config entry for terminating gateways (#7545) 5 years ago
connect.go
connect_ca.go
connect_ca_test.go
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go Catalog + Namespace OSS changes. (#7219) 5 years ago
discovery_chain_test.go
event.go
event_test.go
go.mod wan federation via mesh gateways (#6884) 5 years ago
go.sum wan federation via mesh gateways (#6884) 5 years ago
health.go feat: support sending body in HTTP checks (#6602) 5 years ago
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
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
operator_raft.go
operator_raft_test.go
operator_segment.go
oss_test.go
prepared_query.go Catalog + Namespace OSS changes. (#7219) 5 years ago
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 Updates to the Txn API for namespaces (#7172) 5 years ago
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