open-consul/api
Kyle Havlovitz 9a2474381a Add expanded token read flag and endpoint option 2022-03-31 10:49:49 -07:00
..
watch
.golangci.yml
README.md
acl.go Add expanded token read flag and endpoint option 2022-03-31 10:49:49 -07:00
acl_test.go [OSS] Remove remaining references to master (#11827) 2022-01-20 12:47:50 +00:00
agent.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
agent_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
api.go
api_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
catalog.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
catalog_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
config_entry.go xds: adding control of the mesh-wide min/max TLS versions and cipher suites from the mesh config entry (#12601) 2022-03-30 13:43:59 -05:00
config_entry_discoverychain.go
config_entry_discoverychain_test.go
config_entry_exports.go
config_entry_gateways.go
config_entry_gateways_test.go
config_entry_intentions.go
config_entry_intentions_test.go
config_entry_mesh.go xds: adding control of the mesh-wide min/max TLS versions and cipher suites from the mesh config entry (#12601) 2022-03-30 13:43:59 -05:00
config_entry_test.go xds: adding control of the mesh-wide min/max TLS versions and cipher suites from the mesh config entry (#12601) 2022-03-30 13:43:59 -05: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
connect_intention_test.go
coordinate.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go server: ensure that service-defaults meta is incorporated into the discovery chain response (#12511) 2022-03-30 10:04:18 -05:00
discovery_chain_test.go server: ensure that service-defaults meta is incorporated into the discovery chain response (#12511) 2022-03-30 10:04:18 -05:00
event.go
event_test.go
go.mod
go.sum raft: update to v1.3.5 (#12325) 2022-02-14 13:48:52 -06:00
health.go
health_test.go
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_test.go
partition.go
prepared_query.go
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

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