open-consul/api
funkiestj 386106a139
api: add the ability to specify a path prefix (#12914)
Specifically meant for when consul is behind a reverse proxy / API gateway

Co-authored-by: Evan Culver <eculver@hashicorp.com>
2022-05-19 16:07:59 -07:00
..
watch
.golangci.yml
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 peering: Make Upstream peer-aware (#12900) 2022-04-29 18:12:51 -04:00
agent_test.go peering: initial sync (#12842) 2022-04-21 17:34:40 -05:00
api.go api: add the ability to specify a path prefix (#12914) 2022-05-19 16:07:59 -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
catalog_test.go
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 structs: ensure exported-services PeerName field can be addressed as peer_name (#12862) 2022-04-27 10:27:21 -05:00
config_entry_exports_test.go add general runstep test helper instead of copying it all over the place (#13013) 2022-05-10 15:25:51 -05:00
config_entry_gateways.go
config_entry_gateways_test.go
config_entry_intentions.go
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 remove remaining shim runStep functions (#13015) 2022-05-10 16:24:45 -05:00
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 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 go version to 1.18.1 2022-04-18 11:41:10 -04:00
go.sum Update go version to 1.18.1 2022-04-18 11:41:10 -04: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
peering.go expose meta tags for peering (#12964) 2022-05-09 13:47:37 -07:00
peering_test.go peering: fix panic in test (#13069) 2022-05-13 10:13:02 -07:00
prepared_query.go
prepared_query_test.go
raw.go
README.md
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go
txn_test.go

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