open-consul/api
Freddy 74b7bcb612
Update TestServer creation in sdk/testutil (#6084)
* Retry the creation of the test server three times.
* Reduce the retry timeout for the API wait to 2 seconds, opting to fail faster and start over.
* Remove wait for leader from server creation. This wait can be added on a test by test basis now that the function is being exported.
* Remove wait for anti-entropy sync. This is built into the existing WaitForSerfCheck func, so that can be used if the anti-entropy wait is needed
2019-07-12 09:37:29 -06:00
..
watch Enabling "service" watch handler to accept a slice of tags 2019-04-29 15:28:01 -04:00
README.md Copy-and-paste Go client example (#4448) 2018-07-30 12:48:19 +01:00
acl.go ACL Token ID Initialization (#5307) 2019-04-30 11:45:36 -04:00
acl_test.go Merge pull request #5376 from hashicorp/fix-tests 2019-04-04 17:09:32 -04:00
agent.go Implement data filtering of some endpoints (#5579) 2019-04-16 12:00:15 -04:00
agent_test.go Implement data filtering of some endpoints (#5579) 2019-04-16 12:00:15 -04:00
api.go api: update link to agent caching in comments (#5935) 2019-06-13 23:56:19 +02:00
api_test.go Update TestServer creation in sdk/testutil (#6084) 2019-07-12 09:37:29 -06:00
catalog.go Add support for multiple checks in Consul Client (#4849) 2018-10-29 09:39:25 -07:00
catalog_test.go Update TestServer creation in sdk/testutil (#6084) 2019-07-12 09:37:29 -06:00
config_entry.go Add integration test for central config; fix central config WIP (#5752) 2019-05-01 16:39:31 -07:00
config_entry_test.go Add integration test for central config; fix central config WIP (#5752) 2019-05-01 16:39:31 -07:00
connect.go api: fix up some comments and rename IssuedCert to LeafCert 2018-06-14 09:41:56 -07:00
connect_ca.go connect: tame thundering herd of CSRs on CA rotation (#5228) 2019-01-22 17:19:36 +00:00
connect_ca_test.go Merge pull request #5376 from hashicorp/fix-tests 2019-04-04 17:09:32 -04:00
connect_intention.go agent: 400 error on invalid UUID format, api handles errors properly 2018-06-27 07:40:06 +02:00
connect_intention_test.go agent: 400 error on invalid UUID format, api handles errors properly 2018-06-27 07:40:06 +02:00
coordinate.go Merge branch 'coordinate-node-endpoint' of github.com:hashicorp/consul into esm-changes 2017-10-26 19:20:24 -07: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
event.go Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
event_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
go.mod api: bump sdk version to v0.1.1 2019-05-08 13:18:12 -05:00
go.sum api: go mod tidy 2019-05-08 13:26:07 -05:00
health.go Fall back to using old fields when marshaling 2019-01-28 08:47:26 -08:00
health_test.go Update TestServer creation in sdk/testutil (#6084) 2019-07-12 09:37:29 -06:00
kv.go api: add support for new txn operations 2018-12-12 10:54:09 -08:00
kv_test.go add serf check to TestAPI_ClientPutGetDelete, TestAPI_ClientWatchGet 2019-02-22 17:34:45 -05:00
lock.go Fix lock and semaphore timeouts 2018-07-06 10:55:25 +01:00
lock_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
operator.go Moves operator sub-functions into their own files. 2017-03-30 12:35:50 -07:00
operator_area.go Remove operator_area note from godoc overview (#4603) 2018-08-28 16:02:24 -04:00
operator_autopilot.go Simplify string(buf.Bytes()) to buf.String() (#3590) 2017-10-18 13:26:09 -07:00
operator_autopilot_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
operator_keyring.go agent: display messages from serf in cli (#5236) 2019-01-22 21:08:50 +01:00
operator_keyring_test.go Move internal/ to sdk/ (#5568) 2019-03-27 08:54:56 -04:00
operator_raft.go Move Raft protocol version for list peers end point to server side, fix unit tests. This fixes #3449 2017-09-26 09:35:39 -05: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
prepared_query.go Improve Connect with Prepared Queries (#5291) 2019-02-04 09:36:51 -05: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 Fix lock and semaphore timeouts 2018-07-06 10:55:25 +01:00
semaphore_test.go add serf check to TestAPI_SemaphoreConflict 2019-02-22 17:34:45 -05:00
session.go Expands and rework context support in the API client. (#3273) 2017-07-14 17:30:08 -07:00
session_test.go Improve resilience of api pkg tests (#4676) 2018-09-18 17:47:01 +01:00
snapshot.go Adds support for snapshots and restores. (#2396) 2016-10-25 19:20:24 -07:00
snapshot_test.go add serf check to TestAPI_Snapshot 2019-02-22 17:34:45 -05:00
status.go Revert "fixed: body not closed for non HTTP 200 responses" 2015-01-19 11:51:51 +09:00
status_test.go [Travis][UnstableTests] Fixed unstable tests in travis (#5013) 2018-12-12 12:09:42 -08:00
txn.go txn: update existing txn api docs with new operations 2019-01-15 16:54:07 -08:00
txn_test.go Update TestServer creation in sdk/testutil (#6084) 2019-07-12 09:37:29 -06: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