open-consul/api
2021-10-28 12:24:23 -04:00
..
watch
.golangci.yml
acl.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
acl_test.go api: remove the test for TestAPI_RulesTranslate_Raw 2021-10-05 18:56:27 -04:00
agent.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
agent_test.go
api.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
api_test.go
catalog.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
catalog_test.go
config_entry.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
config_entry_discoverychain.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_discoverychain_test.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_exports.go Rename service-exports to partition-exports 2021-10-25 17:58:48 -06:00
config_entry_gateways.go Final readability tweaks from review 2021-09-23 10:17:12 +01:00
config_entry_gateways_test.go Add changelog; Add API package support for new fields. 2021-09-23 10:12:37 +01:00
config_entry_intentions.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
config_entry_intentions_test.go
config_entry_mesh.go Update filename to match entry kind - mesh 2021-10-27 15:01:26 -06:00
config_entry_test.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
connect.go
connect_ca.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
connect_ca_test.go
connect_intention.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
connect_intention_test.go
coordinate.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
coordinate_test.go
debug.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
debug_test.go
discovery_chain.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
discovery_chain_test.go partition dicovery chains (#10983) 2021-09-07 16:29:32 -04:00
event.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
event_test.go
go.mod deps: update consul-api and consul-sdk (#11361) 2021-10-20 14:58:53 -04:00
go.sum
health.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
health_test.go
kv.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
kv_test.go
lock.go
lock_test.go
mock_api_test.go
namespace.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
namespace_test.go
operator.go
operator_area.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_autopilot.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_autopilot_test.go add StatusError to api package (#11054) 2021-09-20 14:04:13 -07:00
operator_keyring.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_keyring_test.go
operator_license.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_raft.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
operator_raft_test.go
operator_segment.go
oss_test.go
partition.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
prepared_query.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
prepared_query_test.go
raw.go
README.md
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
snapshot_test.go
status.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
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