open-consul/api
John Eikenberry a017daafc8 fix godoc comment for Namespaces client method
Namespaces method godoc has same sentence as Operator method.
Presumably a cut-n-paste error. Fix that.
2022-02-18 04:15:55 +00: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 ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md Copy-and-paste Go client example (#4448) 2018-07-30 12:48:19 +01:00
acl.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
acl_test.go [OSS] Remove remaining references to master (#11827) 2022-01-20 12:47:50 +00:00
agent.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
agent_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
api.go Groundwork for exposing when queries are filtered by ACLs (#11569) 2021-12-03 17:11:26 +00:00
api_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
catalog.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
catalog_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
config_entry.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05:00
config_entry_discoverychain.go Update api module and decoding tests 2021-12-06 12:32:29 -07:00
config_entry_discoverychain_test.go fix test failures 2021-12-06 14:45:44 -06:00
config_entry_exports.go Rename partition-exports to exported-services 2021-12-03 17:47:31 -07: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 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_mesh.go Update filename to match entry kind - mesh 2021-10-27 15:01:26 -06:00
config_entry_test.go bulk rewrite using this script 2022-01-20 10:46:23 -06:00
connect.go api: fix up some comments and rename IssuedCert to LeafCert 2018-06-14 09:41:56 -07:00
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 api: ensure new partition fields are omit empty for back compat (#11585) 2021-11-16 12:28:34 -06: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 agent: ensure that most agent behavior correctly respects partition configuration (#10880) 2021-08-19 15:09:42 -05:00
debug.go Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
debug_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
discovery_chain.go Remove incorrect usage of url.PathEscape (#12184) 2022-01-25 12:15:06 -05: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 Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
go.mod partitions: various refactors to support partitioning the serf LAN pool (#11568) 2021-11-15 09:51:14 -06:00
go.sum raft: update to v1.3.5 (#12325) 2022-02-14 13:48:52 -06:00
health.go Add GRPC and GRPCUseTLS to api.HealthCheckDefinition (#12108) 2022-01-19 16:09:15 -05:00
health_test.go oss: Rename default partition 2021-08-12 14:31:37 -07:00
kv.go KV refactoring, part 2 (#11512) 2021-11-08 11:43:21 -05: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 fix godoc comment for Namespaces client method 2022-02-18 04:15:55 +00:00
namespace_test.go re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
operator.go Moves operator sub-functions into their own files. 2017-03-30 12:35:50 -07:00
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 Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
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 api: refactor: unify naming of API tests 2017-07-07 09:22:34 +02:00
operator_segment.go Change segment list endpoint in docs/client api 2017-09-01 12:40:07 -07:00
oss_test.go re-run gofmt on 1.17 (#11579) 2021-11-16 12:04:01 -06:00
partition.go Clarify feature name in partition docstring 2021-12-03 17:05:17 -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 api: Refactoring into shared write logic 2015-02-18 15:15:02 -08:00
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 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 Refactor requireHttpCodes for segregated error handling (#11287) 2021-10-28 12:24:23 -04:00
snapshot_test.go add serf check to TestAPI_Snapshot 2019-02-22 17:34:45 -05:00
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 KV refactoring, part 2 (#11512) 2021-11-08 11:43:21 -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