consul/api
hc-github-team-consul-core 10cdb2c5ae
Backport of fix: allow snake case keys for ip based rate limit config entry into release/1.16.x (#19292)
* backport of commit 5c2deeb4c6

* backport of commit e91fd9c7d7

---------

Co-authored-by: Poonam Jadhav <poonam.jadhav@hashicorp.com>
2023-10-19 16:28:53 +00:00
..
watch Backport of watch: support -filter for consul watch: checks, services, nodes, service into release/1.16.x (#17965) 2023-06-30 12:59:28 -07:00
.golangci.yml ci: Use golangci-lint for linting 2020-03-17 13:43:40 -04:00
README.md Update the README for the Consul API (#15936) 2023-01-06 21:10:56 +00:00
acl.go [NET-5399] Add support for querying tokens by service name. (#18689) 2023-09-06 13:16:27 -05:00
acl_test.go [NET-5399] Add support for querying tokens by service name. (#18689) 2023-09-06 13:16:27 -05:00
agent.go Manual Backport of Add TCP+TLS Healthchecks into release/1.16.x (#18678) 2023-09-05 14:13:59 -07:00
agent_test.go Backport of member cli: add -filter expression to flags into release/1.16.x (#18276) 2023-07-25 14:57:08 -04:00
api.go Backport of NET-4897 - update comment to include the current issue url from the go team. into release/1.16.x (#18266) 2023-08-03 22:27:55 +00:00
api_test.go Backport of backport ent changes to oss into release/1.16.x (#17617) 2023-06-08 16:45:28 +00:00
catalog.go api: ensure empty locality field is not transmitted to Consul (#17137) 2023-04-26 10:01:17 -05:00
catalog_test.go Backport of NET-4135 - Fix NodeMeta filtering Catalog List Services API into release/1.16.x (#19113) 2023-10-09 10:35:58 +05:30
ce_test.go [BACKPORT] 1.16.x manual backport of OSS->CE branch (#18549) 2023-08-23 11:53:44 -05:00
config_entry.go backport of commit c0afba3a0c (#17975) 2023-06-30 14:20:50 +00:00
config_entry_discoverychain.go Backport of Include RequestTimeout in marshal/unmarshal of ServiceResolverConfigE… into release/1.16.x (#19034) 2023-09-29 17:57:36 +00:00
config_entry_discoverychain_test.go Backport of Include RequestTimeout in marshal/unmarshal of ServiceResolverConfigE… into release/1.16.x (#19034) 2023-09-29 17:57:36 +00:00
config_entry_exports.go add sameness to exported services structs in the api package (#16984) 2023-04-12 16:49:28 -04:00
config_entry_exports_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
config_entry_gateways.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
config_entry_gateways_test.go [BACKPORT] 1.16.x manual backport of OSS->CE branch (#18549) 2023-08-23 11:53:44 -05:00
config_entry_inline_certificate.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
config_entry_inline_certificate_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
config_entry_intentions.go add sameness intentions in api package (#17096) 2023-04-26 10:00:18 -04:00
config_entry_intentions_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
config_entry_jwt_provider.go Expose JWKS cluster config through JWTProviderConfigEntry (#17978) (#18002) 2023-07-04 09:53:12 -04:00
config_entry_jwt_provider_test.go Expose JWKS cluster config through JWTProviderConfigEntry (#17978) (#18002) 2023-07-04 09:53:12 -04:00
config_entry_mesh.go Permissive mTLS (#17035) 2023-04-19 14:45:00 -05:00
config_entry_rate_limit_ip.go Backport of fix: allow snake case keys for ip based rate limit config entry into release/1.16.x (#19292) 2023-10-19 16:28:53 +00:00
config_entry_routes.go Revert "Backport of NET-5530 Support response header modifiers on http-route config entry into release/1.16.x" (#18770) 2023-09-12 19:58:24 +00:00
config_entry_sameness_group.go Fix a bug with disco chain config entry fetching (#17078) 2023-04-21 09:18:32 -04:00
config_entry_status.go APIGW: Update how status conditions for certificates are handled (#17115) 2023-04-27 15:54:44 +00:00
config_entry_status_test.go APIGW Normalize Status Conditions (#16994) 2023-04-24 16:22:55 -04:00
config_entry_test.go Support Envoy's MaxEjectionPercent and BaseEjectionTime config entries for passive health checks (#15979) 2023-04-26 15:59:48 -07:00
connect.go Rename hcp-metrics-collector to consul-telemetry-collector (#17327) 2023-05-16 14:36:05 -04:00
connect_ca.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
connect_ca_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
connect_intention.go Add sameness groups to service intentions. (#17064) 2023-04-20 12:16:04 -04:00
connect_intention_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
coordinate.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
coordinate_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
debug.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
debug_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
discovery_chain.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
discovery_chain_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
event.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
event_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
go.mod Backport of [NET-5944] security: Update Go version to 1.20.10 and `x/net` to 0.17.0 into release/1.16.x (#19234) 2023-10-17 00:12:24 +00:00
go.sum Backport of [NET-5944] security: Update Go version to 1.20.10 and `x/net` to 0.17.0 into release/1.16.x (#19234) 2023-10-17 00:12:24 +00:00
health.go Manual Backport of Add TCP+TLS Healthchecks into release/1.16.x (#18678) 2023-09-05 14:13:59 -07:00
health_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
internal.go Add /v1/internal/service-virtual-ip for manually setting service VIPs (#17294) 2023-05-12 00:38:52 +00:00
internal_test.go Add /v1/internal/service-virtual-ip for manually setting service VIPs (#17294) 2023-05-12 00:38:52 +00:00
kv.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
kv_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
lock.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
lock_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
mock_api_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
namespace.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
namespace_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_area.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_audit.go Backport of Add operator audit endpoint changes into release/1.16.x (#18901) 2023-09-19 17:41:19 +00:00
operator_autopilot.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_autopilot_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_keyring.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_keyring_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_license.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_raft.go Backport of [NET-3865] [Supportability] Additional Information in the output of 'consul operator raft list-peers' into release/1.16.x (#17738) 2023-06-21 11:26:48 +05:30
operator_raft_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_segment.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
operator_usage.go Backport of feat: include nodes count in operator usage endpoint and cli command into release/1.16.x (#18012) 2023-07-05 15:37:51 +00:00
operator_usage_test.go Backport of [API Gateway] Fix rate limiting for API gateways into release/1.16.x (#17635) 2023-06-09 12:40:03 +00:00
partition.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
peering.go api: ensure empty locality field is not transmitted to Consul (#17137) 2023-04-26 10:01:17 -05:00
peering_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
prepared_query.go [NET-3700] add `omitempty` to api prepared query targets (#18184) 2023-07-19 11:57:09 -04:00
prepared_query_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
raw.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
semaphore.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
semaphore_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
session.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
session_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
snapshot.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
snapshot_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
status.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
status_test.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
txn.go Add copyright headers for acl, api and bench folders (#16706) 2023-03-28 16:12:41 -04:00
txn_test.go Backport of Displays Consul version of each nodes in UI nodes section into release/1.16.x (#18113) 2023-07-17 17:27:50 +00: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