consul/api
Daniel Nephin c1d1be2a4b Merge pull request #10155 from hashicorp/dnephin/config-entry-remove-fields
config-entry: remove Kind and Name field from Mesh config entry
2021-05-04 21:28:26 +00:00
..
watch api: Use a Logger instead of an io.Writer in api.Watch 2020-08-05 13:25:08 -04:00
.golangci.yml ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md
acl.go Add fields to the /acl/auth-methods endpoint. (#9741) 2021-02-17 08:16:57 -08:00
acl_test.go Add fields to the /acl/auth-methods endpoint. (#9741) 2021-02-17 08:16:57 -08:00
agent.go Convert new tproxy structs in api module into ptrs 2021-04-13 12:44:25 -06:00
agent_test.go Replace TransparentProxy bool with ProxyMode 2021-04-12 09:35:14 -06:00
api.go Move header methods from config to client 2021-01-20 01:30:54 +00:00
api_test.go Move header methods from config to client 2021-01-20 01:30:54 +00:00
catalog.go Add api mod support for /catalog/gateway-services (#8278) 2020-07-10 13:01:45 -06:00
catalog_test.go Convert new tproxy structs in api module into ptrs 2021-04-13 12:44:25 -06:00
config_entry.go Merge pull request #10155 from hashicorp/dnephin/config-entry-remove-fields 2021-05-04 21:28:26 +00:00
config_entry_cluster.go Merge pull request #10155 from hashicorp/dnephin/config-entry-remove-fields 2021-05-04 21:28:26 +00:00
config_entry_discoverychain.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_discoverychain_test.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_gateways.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_gateways_test.go api: support GetMeta() and GetNamespace() on all config entry kinds (#8764) 2020-09-29 09:11:57 -05:00
config_entry_intentions.go connect: support defining intentions using layer 7 criteria (#8839) 2020-10-06 17:09:13 -05: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 Merge pull request #10155 from hashicorp/dnephin/config-entry-remove-fields 2021-05-04 21:28:26 +00:00
connect.go
connect_ca.go connect/ca: Allow ForceWithoutCrossSigning for all providers 2021-01-29 13:38:11 -08:00
connect_ca_test.go ci: Add staticcheck and fix most errors 2020-05-28 11:59:58 -04:00
connect_intention.go connect: support defining intentions using layer 7 criteria (#8839) 2020-10-06 17:09:13 -05:00
connect_intention_test.go api: unflake some intention-related api tests (#8857) 2020-10-07 13:32:53 -05:00
coordinate.go docs: Miscellaneous docs cleanup (#6742) 2019-11-05 20:34:46 -08:00
coordinate_test.go Merge pull request #5376 from hashicorp/fix-tests 2019-04-04 17:09:32 -04:00
debug.go New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
debug_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
discovery_chain.go Ensure resolver node with LB isn't considered default 2020-09-03 08:55:57 -06:00
discovery_chain_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
event.go
event_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
go.mod Merge pull request #9270 from hashicorp/release/1.9.0 2020-11-24 17:36:47 -05:00
go.sum Update memberlist to v0.2.3 2021-03-24 18:20:19 -04:00
health.go Add support for configuring TLS ServerName for health checks 2021-03-16 18:16:44 -04:00
health_test.go Move ingress param to a new endpoint (#8081) 2020-06-10 13:07:15 -05:00
kv.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06: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 upstream some differences from enterprise (#8902) 2020-10-09 09:42:53 -05:00
namespace_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
operator.go
operator_area.go Remove operator_area note from godoc overview (#4603) 2018-08-28 16:02:24 -04:00
operator_autopilot.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
operator_autopilot_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
operator_keyring.go add primary keys to list keyring (#8522) 2020-08-18 09:50:24 +02:00
operator_keyring_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
operator_license.go Update API module to include the licensed modules in its output (#7661) 2020-04-17 13:39:27 -04:00
operator_raft.go Add unconvert linter 2020-05-12 13:47:25 -04:00
operator_raft_test.go
operator_segment.go
oss_test.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
prepared_query.go Catalog + Namespace OSS changes. (#7219) 2020-02-10 10:40:44 -05:00
prepared_query_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
raw.go
semaphore.go Sync of OSS changes to support namespaces (#6909) 2019-12-09 21:26:41 -05:00
semaphore_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
session.go build: fix makefile and CI 'fmt' and 'vet' tasks (#6937) 2019-12-11 12:32:11 -06:00
session_test.go ci: enable SA4006 staticcheck check 2020-06-16 13:10:11 -04:00
snapshot.go
snapshot_test.go add serf check to TestAPI_Snapshot 2019-02-22 17:34:45 -05:00
status.go api: restore Leader() and Peers() to avoid breaking function signatures (#8395) 2020-07-29 12:09:15 -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 Updates to the Txn API for namespaces (#7172) 2020-01-30 13:12:26 -05:00
txn_test.go Add support for dual stack IPv4/IPv6 network (#6640) 2020-01-17 09:54:17 -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