consul/api
alex de5a991d8c
peering: refactor reconcile, cleanup (#13795)
Signed-off-by: acpana <8968914+acpana@users.noreply.github.com>
2022-07-19 11:43:29 -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 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 UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -04:00
agent_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
api.go Add support for merge-central-config query param (#13001) 2022-05-25 13:20:17 -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 Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
catalog_test.go test: fix flaky test TestAPI_CatalogNodes (#13779) 2022-07-15 13:24:22 -05:00
config_entry.go update gateway-services table with endpoints (#13217) 2022-05-31 16:20:12 -04:00
config_entry_discoverychain.go Update api module and decoding tests 2021-12-06 12:32:29 -07:00
config_entry_discoverychain_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
config_entry_exports.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
config_entry_exports_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
config_entry_gateways.go ingress: allow setting TLS min version and cipher suites in ingress gateway config entries (#11576) 2022-01-11 11:46:42 -05:00
config_entry_gateways_test.go ingress: allow setting TLS min version and cipher suites in ingress gateway config entries (#11576) 2022-01-11 11:46:42 -05:00
config_entry_intentions.go Add SourcePeer fields to relevant Intentions types (#13390) 2022-06-08 13:24:10 -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_mesh.go Fixup missed config entry 2022-05-04 08:50:59 -07:00
config_entry_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
connect.go
connect_ca.go add root_cert_ttl option for consul connect, vault ca providers (#11428) 2021-11-02 11:02:10 -07:00
connect_ca_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
connect_intention.go Add SourcePeer fields to relevant Intentions types (#13390) 2022-06-08 13:24:10 -04:00
connect_intention_test.go Support partitions in connect expose cmd 2021-11-12 14:45:32 -07:00
coordinate.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
coordinate_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
debug.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
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 Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
event_test.go
go.mod Latest submodule versions (#13750) 2022-07-15 09:58:21 -07:00
go.sum Update go version to 1.18.1 2022-04-18 11:41:10 -04:00
health.go UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -04:00
health_test.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
kv.go KV refactoring, part 2 (#11512) 2021-11-08 11:43:21 -05:00
kv_test.go
lock.go Make LockDelay configurable in api locks (#8621) 2020-09-04 13:38:26 -06:00
lock_test.go
mock_api_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
namespace.go remove gogo from acl protobufs 2022-03-28 16:20:56 -04:00
namespace_test.go re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
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 partitions: various refactors to support partitioning the serf LAN pool (#11568) 2021-11-15 09:51:14 -06: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.go [OSS] Pull split ns/partition var out of testing file (#13337) 2022-06-01 14:42:33 -06:00
partition.go Clarify feature name in partition docstring 2021-12-03 17:05:17 -07:00
peering.go Enable partition support for peering establishment (#13772) 2022-07-15 10:07:07 -04:00
peering_test.go peering: refactor reconcile, cleanup (#13795) 2022-07-19 11:43:29 -07:00
prepared_query.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
prepared_query_test.go [OSS] Remove remaining references to master (#11827) 2022-01-20 12:47:50 +00:00
raw.go
semaphore.go
semaphore_test.go
session.go api: properly close the response body 2021-06-14 18:52:59 -04:00
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 bulk rewrite using this script 2022-01-20 10:46:23 -06: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 UDP check for service stanza #12221 (#12722) 2022-06-06 15:13:19 -04: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