open-consul/api
Florian Apolloner cb5389cc89
Allow Operator Generated bootstrap token (#14437)
Add support to provide an initial token via the bootstrap HTTP API, similar to hashicorp/nomad#12520
2023-01-04 20:19:33 +00:00
..
watch
.golangci.yml
README.md
acl.go Allow Operator Generated bootstrap token (#14437) 2023-01-04 20:19:33 +00:00
acl_test.go
agent.go [OSS] feat: access logs for listeners and listener filters (#15864) 2022-12-22 15:18:15 -05:00
agent_test.go Fixing CLI ACL token processing unexpected precedence (#15274) 2022-12-02 12:19:52 -05:00
api.go Fixing CLI ACL token processing unexpected precedence (#15274) 2022-12-02 12:19:52 -05:00
api_test.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
catalog.go
catalog_test.go
config_entry.go [OSS] feat: access logs for listeners and listener filters (#15864) 2022-12-22 15:18:15 -05:00
config_entry_discoverychain.go Add support for configuring Envoys route idle_timeout (#14340) 2022-11-29 17:43:15 -05:00
config_entry_discoverychain_test.go
config_entry_exports.go
config_entry_exports_test.go
config_entry_gateways.go feat(ingress-gateway): support outlier detection of upstream service for ingress gateway (#15614) 2022-12-13 11:51:37 -05:00
config_entry_gateways_test.go feat(ingress-gateway): support outlier detection of upstream service for ingress gateway (#15614) 2022-12-13 11:51:37 -05:00
config_entry_intentions.go
config_entry_intentions_test.go
config_entry_mesh.go
config_entry_test.go Change field to pointer so it will be parsed as nil (#15831) 2022-12-19 10:25:36 -05:00
connect.go
connect_ca.go
connect_ca_test.go update config defaults, add docs (#15302) 2022-11-09 09:29:55 -08:00
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go
debug.go
debug_test.go
discovery_chain.go
discovery_chain_test.go
event.go
event_test.go
go.mod Add 1.14.1 release updates. (#15514) 2022-11-21 13:35:30 -06:00
go.sum Fix SDK to support older versions of Consul. (#15423) 2022-11-18 10:32:01 -06:00
health.go
health_test.go
kv.go
kv_test.go
lock.go
lock_test.go
mock_api_test.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
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 removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
operator_raft.go Leadership transfer cmd (#14132) 2022-11-14 15:35:12 -05:00
operator_raft_test.go Leadership transfer cmd (#14132) 2022-11-14 15:35:12 -05:00
operator_segment.go
oss_test.go
partition.go
peering.go Bring back parameter ServerExternalAddresses in GenerateToken endpoint (#15267) 2022-11-08 14:55:18 -06:00
peering_test.go Bring back parameter ServerExternalAddresses in GenerateToken endpoint (#15267) 2022-11-08 14:55:18 -06:00
prepared_query.go
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
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