consul/api
Kyle Havlovitz 04cd2c983e Add new service-exports config entry 2021-10-20 12:24:18 -07:00
..
watch tests: skip cases that depend on test server when -short flag set (#10576) 2021-07-09 16:42:30 -07:00
.golangci.yml
README.md
acl.go api: add partition field to acl structs (#11080) 2021-09-17 11:53:03 -05:00
acl_test.go acl-tokens table partitioning (#11020) 2021-09-13 16:53:09 -04:00
agent.go wrap few doRequest calls for error handling (#11158) 2021-09-29 13:12:15 -07:00
agent_test.go agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
api.go add StatusError to api package (#11054) 2021-09-20 14:04:13 -07:00
api_test.go sync changes to oss files made in enterprise (#10670) 2021-07-22 13:58:08 -05:00
catalog.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
catalog_test.go state: partition nodes and coordinates in the state store (#10859) 2021-08-17 13:29:39 -05:00
config_entry.go Add new service-exports config entry 2021-10-20 12:24:18 -07:00
config_entry_cluster.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -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 Add new service-exports config entry 2021-10-20 12:24:18 -07: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 connect: intentions are now managed as a new config entry kind "service-intentions" (#8834) 2020-10-06 13:24:05 -05:00
config_entry_test.go Sync partition fields from enterprise (#11021) 2021-09-13 17:53:52 -04:00
connect.go
connect_ca.go ca: remove unused RotationPeriod field 2021-07-05 19:15:44 -04:00
connect_ca_test.go ca: remove unused RotationPeriod field 2021-07-05 19:15:44 -04:00
connect_intention.go api: properly close the response body 2021-06-14 18:52:59 -04:00
connect_intention_test.go api: unflake some intention-related api tests (#8857) 2020-10-07 13:32:53 -05:00
coordinate.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
coordinate_test.go agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
debug.go wrap few doRequest calls for error handling (#11158) 2021-09-29 13:12:15 -07:00
debug_test.go
discovery_chain.go api: properly close the response body 2021-06-14 18:52:59 -04:00
discovery_chain_test.go partition dicovery chains (#10983) 2021-09-07 16:29:32 -04:00
event.go api: properly close the response body 2021-06-14 18:52:59 -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 Update memberlist to v0.2.3 2021-03-24 18:20:19 -04:00
health.go http: add partition query param parsing 2021-07-14 12:07:38 -07:00
health_test.go oss: Rename default partition 2021-08-12 14:31:37 -07:00
kv.go wrap few doRequest calls for error handling (#11158) 2021-09-29 13:12:15 -07:00
kv_test.go ci: Enabled SA2002 staticcheck check 2020-06-05 17:50:11 -04:00
lock.go Make LockDelay configurable in api locks (#8621) 2020-09-04 13:38:26 -06:00
lock_test.go ci: Enabled SA2002 staticcheck check 2020-06-05 17:50:11 -04:00
mock_api_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
namespace.go api: properly close the response body 2021-06-14 18:52:59 -04:00
namespace_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
operator.go
operator_area.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_autopilot.go add StatusError to api package (#11054) 2021-09-20 14:04:13 -07:00
operator_autopilot_test.go add StatusError to api package (#11054) 2021-09-20 14:04:13 -07:00
operator_keyring.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_keyring_test.go
operator_license.go Revert early out errors in license API (#10952) 2021-08-31 10:36:35 -06:00
operator_raft.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_raft_test.go
operator_segment.go
oss_test.go oss: Rename default partition 2021-08-12 14:31:37 -07:00
partition.go Sync partitions support in api module (#10938) 2021-08-26 18:40:34 -06:00
prepared_query.go api: properly close the response body 2021-06-14 18:52:59 -04:00
prepared_query_test.go
raw.go
semaphore.go
semaphore_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
session.go api: properly close the response body 2021-06-14 18:52:59 -04:00
session_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
snapshot.go Always set the Content-Type header when a body is present (#10204) 2021-05-25 16:03:48 +01:00
snapshot_test.go
status.go api: properly close the response body 2021-06-14 18:52:59 -04:00
status_test.go api: restore Leader() and Peers() to avoid breaking function signatures (#8395) 2020-07-29 12:09:15 -04:00
txn.go replumbing a bunch of api and agent structs for partitions (#10681) 2021-07-22 14:33:22 -05:00
txn_test.go state: partition nodes and coordinates in the state store (#10859) 2021-08-17 13:29:39 -05:00

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