consul/api
Andrew Stucki 9bb0ecfc18
[API Gateway] Add integration test for HTTP routes (#16236)
* [API Gateway] Add integration test for conflicted TCP listeners

* [API Gateway] Update simple test to leverage intentions and multiple listeners

* Fix broken unit test

* [API Gateway] Add integration test for HTTP routes
2023-02-13 14:18:05 -05:00
..
watch Regenerate files according to 1.19.2 formatter 2022-10-24 16:12:08 -04:00
.golangci.yml
README.md Update the README for the Consul API (#15936) 2023-01-06 21:10:56 +00:00
acl.go Update token language to distinguish Accessor and Secret ID usage (#16044) 2023-02-07 12:26:30 -06:00
acl_test.go Synthesize anonymous token pre-bootstrap when needed (#16200) 2023-02-09 20:34:02 +00:00
agent.go Add some fixes to allow for registering via consul connect envoy -gateway api (#16219) 2023-02-09 20:28:04 +00:00
agent_test.go Remove legacy acl policies (#15922) 2023-02-06 15:35:52 +00:00
api.go Add the `operator usage instances` command and api endpoint (#16205) 2023-02-08 12:07:21 -08:00
api_test.go Synthesize anonymous token pre-bootstrap when needed (#16200) 2023-02-09 20:34:02 +00:00
catalog.go fix(txn api): missing proxy config in registering proxy service (#14471) 2022-09-02 14:28:05 -04:00
catalog_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
config_entry.go feat: envoy extension - http local rate limit (#16196) 2023-02-07 21:56:15 -05:00
config_entry_discoverychain.go Add support for configuring Envoys route idle_timeout (#14340) 2022-11-29 17:43:15 -05:00
config_entry_discoverychain_test.go Add the ability to retry on reset connection to service-routers (#12890) 2022-10-05 13:06:44 -04:00
config_entry_exports.go Update api package exported services comment. (#15285) 2022-11-08 09:26:07 -05:00
config_entry_exports_test.go Rename `PeerName` to `Peer` on prepared queries and exported services (#14854) 2022-10-04 14:46:15 -04:00
config_entry_gateways.go Native API Gateway Config Entries (#15897) 2023-01-18 22:14:34 +00:00
config_entry_gateways_test.go feat(ingress-gateway): support outlier detection of upstream service for ingress gateway (#15614) 2022-12-13 11:51:37 -05:00
config_entry_inline_certificate.go Native API Gateway Config Entries (#15897) 2023-01-18 22:14:34 +00:00
config_entry_intentions.go
config_entry_intentions_test.go
config_entry_mesh.go feat: add PeerThroughMeshGateways to mesh config 2022-09-13 17:19:54 -04:00
config_entry_routes.go [API Gateway] Add integration test for HTTP routes (#16236) 2023-02-13 14:18:05 -05:00
config_entry_status.go Add additional controller implementations (#16188) 2023-02-08 14:50:17 -05:00
config_entry_test.go Change field to pointer so it will be parsed as nil (#15831) 2022-12-19 10:25:36 -05:00
connect.go
connect_ca.go
connect_ca_test.go update config defaults, add docs (#15302) 2022-11-09 09:29:55 -08:00
connect_intention.go
connect_intention_test.go
coordinate.go
coordinate_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
debug.go Allow consul debug on non-ACL consul servers (#15155) 2022-10-27 09:25:18 -04:00
debug_test.go
discovery_chain.go
discovery_chain_test.go
event.go
event_test.go
go.mod Add 1.14.1 release updates. (#15514) 2022-11-21 13:35:30 -06:00
go.sum Fix SDK to support older versions of Consul. (#15423) 2022-11-18 10:32:01 -06:00
health.go Merge pull request #13388 from deblasis/feature/health-checks_windows_service 2022-10-17 09:26:19 -04:00
health_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
kv.go
kv_test.go
lock.go
lock_test.go
mock_api_test.go removes ioutil usage everywhere which was deprecated in go1.16 (#15297) 2022-11-10 10:26:01 -06:00
namespace.go
namespace_test.go
operator.go
operator_area.go
operator_autopilot.go
operator_autopilot_test.go
operator_keyring.go
operator_keyring_test.go
operator_license.go Remove legacy acl policies (#15922) 2023-02-06 15:35:52 +00:00
operator_raft.go Leadership transfer cmd (#14132) 2022-11-14 15:35:12 -05:00
operator_raft_test.go Leadership transfer cmd (#14132) 2022-11-14 15:35:12 -05:00
operator_segment.go
operator_usage.go Add the `operator usage instances` command and api endpoint (#16205) 2023-02-08 12:07:21 -08:00
operator_usage_test.go Add the `operator usage instances` command and api endpoint (#16205) 2023-02-08 12:07:21 -08:00
oss_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00
partition.go
peering.go Bring back parameter ServerExternalAddresses in GenerateToken endpoint (#15267) 2022-11-08 14:55:18 -06:00
peering_test.go Bring back parameter ServerExternalAddresses in GenerateToken endpoint (#15267) 2022-11-08 14:55:18 -06:00
prepared_query.go Remove empty tags 2 (#16113) 2023-02-06 11:12:43 -08:00
prepared_query_test.go Remove empty tags 2 (#16113) 2023-02-06 11:12:43 -08:00
raw.go
semaphore.go
semaphore_test.go
session.go
session_test.go
snapshot.go
snapshot_test.go
status.go
status_test.go
txn.go Add kv txn get-not-exists operation. 2022-09-06 10:28:59 -05:00
txn_test.go fix(api): OSS<->ENT exported service incompatibility 2022-09-02 12:07:02 -04:00

README.md

Consul API Client

This package provides the api package which provides programmatic access to the full Consul API.

The full documentation is available on Godoc.

Usage

Below is an example of using the Consul client. To run the example, you must first install Consul and Go.

To run the client API, create a new Go module.

go mod init consul-demo

Copy the example code into a file called main.go in the directory where the module is defined. As seen in the example, the Consul API is often imported with the alias capi.

package main

import (
	"fmt"

	capi "github.com/hashicorp/consul/api"
)

func main() {
	// Get a new client
	client, err := capi.NewClient(capi.DefaultConfig())
	if err != nil {
		panic(err)
	}

	// Get a handle to the KV API
	kv := client.KV()

	// PUT a new KV pair
	p := &capi.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)
}

Install the Consul API dependency with go mod tidy.

In a separate terminal window, start a local Consul server.

consul agent -dev -node machine

Run the example.

go run .

You should get the following result printed to the terminal.

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