open-consul/api
Dhia Ayachi f766b6dff7
oss portion of ent #1069 (#10883)
2021-08-20 12:57:45 -04: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 Merge pull request #10612 from bigmikes/acl-replication-fix 2021-08-06 18:29:51 -04:00
acl_test.go api: remove client library tests for old API endpoints 2021-08-17 13:09:30 -04:00
agent.go oss portion of ent #1069 (#10883) 2021-08-20 12:57:45 -04: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 sync changes to oss files made in enterprise (#10670) 2021-07-22 13:58:08 -05: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 api: properly close the response body 2021-06-14 18:52:59 -04:00
config_entry_cluster.go Rename CatalogDestinationsOnly (#10397) 2021-06-14 14:15:09 -06: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 Rename CatalogDestinationsOnly (#10397) 2021-06-14 14:15:09 -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 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 debug: restore cancel on SigInt 2021-08-18 12:29:34 -04:00
debug_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
discovery_chain.go api: properly close the response body 2021-06-14 18:52:59 -04:00
discovery_chain_test.go Enable gofmt simplify 2020-06-16 13:21:11 -04:00
event.go api: properly close the response body 2021-06-14 18:52:59 -04:00
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 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 api: properly close the response body 2021-06-14 18:52:59 -04: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 Moves operator sub-functions into their own files. 2017-03-30 12:35:50 -07:00
operator_area.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_autopilot.go Fix defaults for autopilot config update 2021-07-06 18:39:40 -04:00
operator_autopilot_test.go AutopilotServerHealth now handles the 429 status code (#8599) 2021-03-12 09:40:49 -05:00
operator_keyring.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_keyring_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
operator_license.go api: properly close the response body 2021-06-14 18:52:59 -04:00
operator_raft.go api: properly close the response body 2021-06-14 18:52:59 -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 oss: Rename default partition 2021-08-12 14:31:37 -07:00
prepared_query.go api: properly close the response body 2021-06-14 18:52:59 -04:00
prepared_query_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04: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 Always set the Content-Type header when a body is present (#10204) 2021-05-25 16:03:48 +01:00
snapshot_test.go add serf check to TestAPI_Snapshot 2019-02-22 17:34:45 -05:00
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