Consul API

https://pkg.go.dev/github.com/hashicorp/consul/api
Admin
Consul API is a Go client library that provides programmatic access to HashiCorp Consul for service...
Tokens:217,578
Snippets:1,810
Trust Score:9.6
Update:1 week ago
Show doc for...
Tokens:
Raw
### Consul client example: KV put and get

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Complete Go program that creates a Consul client, writes a KV pair, reads it back, and prints the result. Uses the capi alias for the Consul API package.

```go
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)
}

```

--------------------------------

### Operator.KeyringInstall

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Installs a new encryption key.

```APIDOC
## Operator.KeyringInstall

### Description
Installs a new encryption key.

### Method
KeyringInstall

### Parameters
- **key** (string) - Required - The encryption key to install.
- **q** (*WriteOptions) - Required - Write options for the request.

### Returns
- **error** - An error if the operation fails.
```

--------------------------------

### Run the Go example

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Executes the Go program from the module directory.

```bash
go run .

```

--------------------------------

### ConfigEntries.Get

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets a configuration entry.

```APIDOC
## ConfigEntries.Get

### Description
Gets a configuration entry.

### Method
Get

### Signature
func (conf *ConfigEntries) Get(kind string, name string, q *QueryOptions) (ConfigEntry, *QueryMeta, error)

### Parameters
- **kind** (string) - Required - The kind of configuration entry.
- **name** (string) - Required - The name of the configuration entry.
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **ConfigEntry** - The configuration entry.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### Initialize Go module for Consul demo

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Run this command to create a new Go module named 'consul-demo' before copying the example code.

```bash
go mod init consul-demo

```

--------------------------------

### Expected output of the example

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

The program prints the KV pair key and value.

```text
KV: REDIS_MAXCLIENTS 1000

```

--------------------------------

### Connect.CAGetConfig

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the CA configuration.

```APIDOC
## Connect.CAGetConfig

### Description
Gets the CA configuration.

### Method
CAGetConfig

### Signature
func (h *Connect) CAGetConfig(q *QueryOptions) (*CAConfig, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **CAConfig** (*CAConfig) - The CA configuration.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### func (*Operator) KeyringInstall

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Installs a new gossip encryption key into the cluster.

```APIDOC
## func (*Operator) KeyringInstall

### Description
KeyringInstall is used to install a new gossip encryption key into the cluster.

### Method
func

### Signature
func (op *Operator) KeyringInstall(key string, q *WriteOptions) error

### Parameters
- **key** (string) - Required - The gossip encryption key to install.
- **q** (*WriteOptions) - Optional - Write options for the request.

### Returns
- **error** - Error if any.
```

--------------------------------

### Example of using Txn method

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Shows how to construct a transaction with KV and check operations and call the Txn method. The ok value indicates success, and the response contains results or errors.

```go
   ops := KVTxnOps{
	   &KVTxnOp{
		   Verb:    KVLock,
		   Key:     "test/lock",
		   Session: "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
		   Value:   []byte("hello"),
	   },
	   &KVTxnOp{
		   Verb:    KVGet,
		   Key:     "another/key",
	   },
	   &CheckTxnOp{
		   Verb:        CheckSet,
		   HealthCheck: HealthCheck{
			   Node:    "foo",
			   CheckID: "redis:a",
			   Name:    "Redis Health Check",
			   Status:  "passing",
		   },
	   }
   }
   ok, response, _, err := kv.Txn(&ops, nil)
```

--------------------------------

### Consul API client example (main.go)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Complete Go program that creates a Consul client, puts a KV pair 'REDIS_MAXCLIENTS' with value '1000', and retrieves it. The Consul API is imported with alias 'capi'. Requires a running Consul agent.

```go
package main

import (
	"fmt"

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

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)
}

```

--------------------------------

### func (*ConfigEntries) Get(kind string, name string, q *QueryOptions) (ConfigEntry, *QueryMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Retrieves a config entry by kind and name.

```APIDOC
## func (*ConfigEntries) Get(kind string, name string, q *QueryOptions) (ConfigEntry, *QueryMeta, error)

### Description
Retrieves a config entry by kind and name.

### Signature
func (conf *ConfigEntries) Get(kind string, name string, q *QueryOptions) (ConfigEntry, *QueryMeta, error)

### Parameters
- kind (string) - Required - The kind of the config entry.
- name (string) - Required - The name of the config entry.
- q (*QueryOptions) - Optional - Query options.

### Returns
- ConfigEntry - The retrieved config entry.
- *QueryMeta - Query metadata.
- error - Error if any.
```

--------------------------------

### Start local Consul agent

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Run this command in a separate terminal to start a local Consul server in dev mode with node name 'machine'.

```bash
consul agent -dev -node machine

```

--------------------------------

### Bootstrap

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Performs a one-time ACL bootstrap operation on a cluster to get the first management token.

```APIDOC
## Bootstrap

### Description
Performs a one-time ACL bootstrap operation on a cluster to get the first management token.

### Method
func (a *ACL) Bootstrap() (*ACLToken, *WriteMeta, error)

### Parameters
None.

### Returns
- **ACLToken** - The initial management token.
- **WriteMeta** - Metadata about the write operation.
- **error** - An error if the operation failed.
```

--------------------------------

### func (d *DiscoveryChain) Get(name string, opts *DiscoveryChainOptions, q *QueryOptions) (*DiscoveryChainResponse, *QueryMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Retrieves the discovery chain for a given service name. The opts parameter allows customization of the request, and q provides query options.

```APIDOC
## func (d *DiscoveryChain) Get(name string, opts *DiscoveryChainOptions, q *QueryOptions) (*DiscoveryChainResponse, *QueryMeta, error)

### Description
Retrieves the discovery chain for a given service name.

### Method
Get

### Signature
func (d *DiscoveryChain) Get(name string, opts *DiscoveryChainOptions, q *QueryOptions) (*DiscoveryChainResponse, *QueryMeta, error)

### Parameters
- **name** (string) - Required - The name of the service.
- **opts** (*DiscoveryChainOptions) - Optional - Options for the discovery chain request.
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **\*DiscoveryChainResponse** - The discovery chain response.
- **\*QueryMeta** - Query metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### func (*KV) Get

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Looks up a single key. The returned pointer to the KVPair will be nil if the key does not exist.

```APIDOC
## func (*KV) Get

### Description
Get is used to lookup a single key. The returned pointer to the KVPair will be nil if the key does not exist.

### Method
Get

### Signature
func (k *KV) Get(key string, q *QueryOptions) (*KVPair, *QueryMeta, error)

### Parameters
- **key** (string) - Required - The key to look up.
- **q** (*QueryOptions) - Optional - Query options for the operation.

### Returns
- **KVPair** - The key-value pair, or nil if not found.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### Debug.Goroutine

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the goroutine dump.

```APIDOC
## Debug.Goroutine

### Description
Gets the goroutine dump.

### Method
Goroutine

### Signature
func (d *Debug) Goroutine() ([]byte, error)

### Returns
- **[]byte** - The goroutine dump.
- **error** - Error if any.

```

--------------------------------

### Connect.CARoots

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the CA roots.

```APIDOC
## Connect.CARoots

### Description
Gets the CA roots.

### Method
CARoots

### Signature
func (h *Connect) CARoots(q *QueryOptions) (*CARootList, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **CARootList** (*CARootList) - The CA root list.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### Partitions.Create

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Creates a new partition with the given configuration. It returns the created partition and write metadata, or an error.

```APIDOC
## Partitions.Create

### Description
Creates a new partition with the given configuration. It returns the created partition and write metadata, or an error.

### Method
Create

### Signature
func (p *Partitions) Create(ctx context.Context, partition *Partition, q *WriteOptions) (*Partition, *WriteMeta, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **partition** (*Partition) - Required - The partition configuration to create.
- **q** (*WriteOptions) - Optional - Write options for the request.

### Returns
- **partition** (*Partition) - The created partition.
- **writeMeta** (*WriteMeta) - Write metadata.
- **error** - An error if the operation failed.
```

--------------------------------

### Coordinate.Nodes

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the network coordinates for all nodes.

```APIDOC
## Coordinate.Nodes

### Description
Gets the network coordinates for all nodes.

### Method
Nodes

### Signature
func (c *Coordinate) Nodes(q *QueryOptions) ([]*CoordinateEntry, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **[]*CoordinateEntry** - List of coordinate entries.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### Coordinate.Datacenters

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the network coordinates for all datacenters.

```APIDOC
## Coordinate.Datacenters

### Description
Gets the network coordinates for all datacenters.

### Method
Datacenters

### Signature
func (c *Coordinate) Datacenters() ([]*CoordinateDatacenterMap, error)

### Returns
- **[]*CoordinateDatacenterMap** - List of datacenter coordinate maps.
- **error** - Error if any.

```

--------------------------------

### func (*Partitions) Create

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Creates a new admin partition.

```APIDOC
## func (*Partitions) Create

### Description
Creates a new admin partition.

### Method
Create

### Signature
func (p *Partitions) Create(ctx context.Context, partition *Partition, q *WriteOptions) (*Partition, *WriteMeta, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **partition** (*Partition) - Required - The partition to create.
- **q** (*WriteOptions) - Optional - Write options for the request.

### Returns
- ***Partition** - The created partition.
- ***WriteMeta** - Write metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### Connect.IntentionGetExact

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets an intention by source and destination.

```APIDOC
## Connect.IntentionGetExact

### Description
Gets an intention by source and destination.

### Method
IntentionGetExact

### Signature
func (h *Connect) IntentionGetExact(source, destination string, q *QueryOptions) (*Intention, *QueryMeta, error)

### Parameters
- **source** (string) - Required - The source service.
- **destination** (string) - Required - The destination service.
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **Intention** (*Intention) - The intention.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### Connect.IntentionGet

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets an intention by ID. Deprecated.

```APIDOC
## Connect.IntentionGet

### Description
Gets an intention by ID. Deprecated.

### Method
IntentionGet

### Signature
func (h *Connect) IntentionGet(id string, q *QueryOptions) (*Intention, *QueryMeta, error)

### Parameters
- **id** (string) - Required - The ID of the intention.
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **Intention** (*Intention) - The intention.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### Catalog.Connect(service, tag string, q *QueryOptions)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Returns the connect-enabled services for a given service and tag.

```APIDOC
## Catalog.Connect(service, tag string, q *QueryOptions)

### Description
Returns the connect-enabled services for a given service and tag.

### Method
Connect

### Signature
func (c *Catalog) Connect(service, tag string, q *QueryOptions) ([]*CatalogService, *QueryMeta, error)

### Parameters
- **service** (string) - Required - The service name.
- **tag** (string) - Required - The tag to filter by.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Response
- **[]*CatalogService** - List of catalog services.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### func (*Session) Node

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Gets sessions for a node.

```APIDOC
## func (*Session) Node

### Description
Gets sessions for a node.

### Method
Node

### Signature
`func (s *Session) Node(node string, q *QueryOptions) ([]*SessionEntry, *QueryMeta, error)`

### Parameters
- **node** (string) - The node name.
- **q** (*QueryOptions) - The query options.

### Returns
- **[]*SessionEntry** - A list of session entries.
- ***QueryMeta** - The query metadata.
- **error** - An error if any.
```

--------------------------------

### Connect.CASetConfig

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Sets the CA configuration.

```APIDOC
## Connect.CASetConfig

### Description
Sets the CA configuration.

### Method
CASetConfig

### Signature
func (h *Connect) CASetConfig(conf *CAConfig, q *WriteOptions) (*WriteMeta, error)

### Parameters
- **conf** (*CAConfig) - Required - The CA configuration.
- **q** (*WriteOptions) - Optional - Write options.

### Returns
- **WriteMeta** (*WriteMeta) - Write metadata.
- **error** - Error if any.

```

--------------------------------

### func (*Session) List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Gets all active sessions.

```APIDOC
## func (*Session) List

### Description
Gets all active sessions.

### Method
List

### Signature
`func (s *Session) List(q *QueryOptions) ([]*SessionEntry, *QueryMeta, error)`

### Parameters
- **q** (*QueryOptions) - The query options.

### Returns
- **[]*SessionEntry** - A list of session entries.
- ***QueryMeta** - The query metadata.
- **error** - An error if any.
```

--------------------------------

### Partitions.List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Lists all partitions. It returns a slice of partitions and query metadata, or an error.

```APIDOC
## Partitions.List

### Description
Lists all partitions. It returns a slice of partitions and query metadata, or an error.

### Method
List

### Signature
func (p *Partitions) List(ctx context.Context, q *QueryOptions) ([]*Partition, *QueryMeta, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **partitions** ([]*Partition) - A list of partitions.
- **queryMeta** (*QueryMeta) - Query metadata.
- **error** - An error if the operation failed.
```

--------------------------------

### Coordinate.Node

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the network coordinates for a specific node.

```APIDOC
## Coordinate.Node

### Description
Gets the network coordinates for a specific node.

### Method
Node

### Signature
func (c *Coordinate) Node(node string, q *QueryOptions) ([]*CoordinateEntry, *QueryMeta, error)

### Parameters
- **node** (string) - Required - The node name.
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **[]*CoordinateEntry** - List of coordinate entries.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```

--------------------------------

### Namespaces.Create

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Creates a new namespace.

```APIDOC
## Namespaces.Create

### Description
Creates a new namespace.

### Method
Create

### Parameters
- **ns** (*Namespace) - Required - The namespace to create.
- **q** (*WriteOptions) - Required - Write options for the request.

### Returns
- ***Namespace** - The created namespace.
- ***WriteMeta** - Write metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### func (*Operator) FeatureGateGet

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Gets the state of a feature gate.

```APIDOC
## func (*Operator) FeatureGateGet

### Description
FeatureGateGet gets the state of a feature gate.

### Method
func

### Signature
func (op *Operator) FeatureGateGet(name string, q *QueryOptions) (*FeatureGate, *QueryMeta, error)

### Parameters
- **name** (string) - Required - The name of the feature gate.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **FeatureGate** - The feature gate state.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### NodeName

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

NodeName is used to get the node name of the agent.

```APIDOC
## NodeName

### Description
NodeName is used to get the node name of the agent.

### Method
NodeName

### Signature
func (a *Agent) NodeName() (string, error)

### Returns
- **string** - The node name.
- **error** - An error if the operation fails.
```

--------------------------------

### Catalog.Services(q *QueryOptions)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Returns all services in the catalog.

```APIDOC
## Catalog.Services(q *QueryOptions)

### Description
Returns all services in the catalog.

### Method
Services

### Signature
func (c *Catalog) Services(q *QueryOptions) (map[string][]string, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Response
- **map[string][]string** - Map of service name to list of tags.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### Catalog.GatewayServices(gateway string, q *QueryOptions)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Returns the services associated with a gateway.

```APIDOC
## Catalog.GatewayServices(gateway string, q *QueryOptions)

### Description
Returns the services associated with a gateway.

### Method
GatewayServices

### Signature
func (c *Catalog) GatewayServices(gateway string, q *QueryOptions) ([]*GatewayService, *QueryMeta, error)

### Parameters
- **gateway** (string) - Required - The gateway name.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Response
- **[]*GatewayService** - List of gateway services.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### OIDCAuthURL

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Requests an authorization URL to start an OIDC login flow.

```APIDOC
## OIDCAuthURL

### Description
Requests an authorization URL to start an OIDC login flow.

### Method
func (a *ACL) OIDCAuthURL(auth *ACLOIDCAuthURLParams, q *WriteOptions) (string, *WriteMeta, error)

### Parameters
- **auth** (*ACLOIDCAuthURLParams) - Required - Parameters for the OIDC authorization URL request.
- **q** (*WriteOptions) - Optional - Write options for the request.

### Returns
- **string** - The authorization URL.
- **WriteMeta** - Metadata about the write operation.
- **error** - An error if the operation failed.
```

--------------------------------

### func (*Operator) LicenseGetSigned

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Gets the signed Consul Enterprise license.

```APIDOC
## func (*Operator) LicenseGetSigned

### Description
LicenseGetSigned gets the signed Consul Enterprise license.

### Method
func

### Signature
func (op *Operator) LicenseGetSigned(q *QueryOptions) (string, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **string** - The signed license.
- **error** - Error if any.
```

--------------------------------

### func (*ConfigEntries) List(kind string, q *QueryOptions) ([]ConfigEntry, *QueryMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Lists all config entries of a given kind.

```APIDOC
## func (*ConfigEntries) List(kind string, q *QueryOptions) ([]ConfigEntry, *QueryMeta, error)

### Description
Lists all config entries of a given kind.

### Signature
func (conf *ConfigEntries) List(kind string, q *QueryOptions) ([]ConfigEntry, *QueryMeta, error)

### Parameters
- kind (string) - Required - The kind of config entries to list.
- q (*QueryOptions) - Optional - Query options.

### Returns
- []ConfigEntry - The list of config entries.
- *QueryMeta - Query metadata.
- error - Error if any.
```

--------------------------------

### ACL.Bootstrap

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Bootstraps the ACL system. Returns the initial ACL token and write metadata.

```APIDOC
## ACL.Bootstrap

### Description
Bootstraps the ACL system.

### Method
POST

### Endpoint
/acl/bootstrap

### Parameters
#### Query Parameters
- **q** (WriteOptions) - Optional - Write options.

### Response
#### Success Response (200)
- **ACLToken** - The initial ACL token.
- **WriteMeta** - Write metadata.

#### Response Example
```json
{
  "AccessorID": "accessor-id",
  "SecretID": "secret-id"
}
```
```

--------------------------------

### func (*Operator) LicenseGet

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Gets the current Consul Enterprise license.

```APIDOC
## func (*Operator) LicenseGet

### Description
LicenseGet gets the current Consul Enterprise license.

### Method
func

### Signature
func (op *Operator) LicenseGet(q *QueryOptions) (*LicenseReply, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **LicenseReply** - The license reply.
- **error** - Error if any.
```

--------------------------------

### Client.SemaphoreOpts

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Creates a semaphore with the given options.

```APIDOC
## Client.SemaphoreOpts

### Description
Creates a semaphore with the given options.

### Method
SemaphoreOpts

### Signature
func (c *Client) SemaphoreOpts(opts *SemaphoreOptions) (*Semaphore, error)

### Parameters
- **opts** (*SemaphoreOptions) - Required - Semaphore options.

### Returns
- **Semaphore** (*Semaphore) - The semaphore object.
- **error** - Error if any.

```

--------------------------------

### func (*Operator) KeyringList

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Lists the gossip keys installed in the cluster.

```APIDOC
## func (*Operator) KeyringList

### Description
KeyringList is used to list the gossip keys installed in the cluster.

### Method
func

### Signature
func (op *Operator) KeyringList(q *QueryOptions) ([]*KeyringResponse, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **[]*KeyringResponse** - List of keyring responses.
- **error** - Error if any.
```

--------------------------------

### Client.SemaphorePrefix

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Creates a semaphore with the given prefix and limit.

```APIDOC
## Client.SemaphorePrefix

### Description
Creates a semaphore with the given prefix and limit.

### Method
SemaphorePrefix

### Signature
func (c *Client) SemaphorePrefix(prefix string, limit int) (*Semaphore, error)

### Parameters
- **prefix** (string) - Required - The prefix for the semaphore.
- **limit** (int) - Required - The limit for the semaphore.

### Returns
- **Semaphore** (*Semaphore) - The semaphore object.
- **error** - Error if any.

```

--------------------------------

### func (*PreparedQuery) Get

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Fetches a specific prepared query by its query ID.

```APIDOC
## func (*PreparedQuery) Get

### Description
Get is used to fetch a specific prepared query.

### Signature
func (c *PreparedQuery) Get(queryID string, q *QueryOptions) ([]*PreparedQueryDefinition, *QueryMeta, error)

### Parameters
- **queryID** (string) - Required - The ID of the prepared query to fetch.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **PreparedQueryDefinition** ([]*PreparedQueryDefinition) - The list of prepared query definitions.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** (error) - Error if any.
```

--------------------------------

### func (*Connect) CASetConfig(conf *CAConfig, q *WriteOptions) (*WriteMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Sets the current CA configuration.

```APIDOC
## func (*Connect) CASetConfig(conf *CAConfig, q *WriteOptions) (*WriteMeta, error)

### Description
CASetConfig sets the current CA configuration.

### Signature
func (h *Connect) CASetConfig(conf *CAConfig, q *WriteOptions) (*WriteMeta, error)

### Parameters
- conf (*CAConfig) - Required - The CA configuration to set.
- q (*WriteOptions) - Optional - Write options.

### Returns
- *WriteMeta - Write metadata.
- error - Error if any.
```

--------------------------------

### func (*Agent) ConnectCALeaf

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the leaf certificate for the given service ID.

```APIDOC
## func (*Agent) ConnectCALeaf

### Description
Gets the leaf certificate for the given service ID.

### Method
ConnectCALeaf

### Signature
func (a *Agent) ConnectCALeaf(serviceID string, q *QueryOptions) (*LeafCert, *QueryMeta, error)

### Parameters
- **serviceID** (string) - Required - The service ID.
- **q** (*QueryOptions) - Required - Query options for the request.

### Returns
- **LeafCert** - The leaf certificate.
- **QueryMeta** - Query metadata.
- **error** - An error if the request fails.
```

--------------------------------

### func (*Partitions) List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Lists all admin partitions.

```APIDOC
## func (*Partitions) List

### Description
Lists all admin partitions.

### Method
List

### Signature
func (p *Partitions) List(ctx context.Context, q *QueryOptions) ([]*Partition, *QueryMeta, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **[]*Partition** - A list of partitions.
- ***QueryMeta** - Query metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### List (deprecated)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets all the ACL tokens. Deprecated: Use TokenList instead.

```APIDOC
## List (deprecated)

### Description
Gets all the ACL tokens. Deprecated: Use TokenList instead.

### Method
func (a *ACL) List(q *QueryOptions) ([]*ACLEntry, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **[]*ACLEntry** - A list of ACL tokens.
- **QueryMeta** - Metadata about the query.
- **error** - An error if the operation failed.
```

--------------------------------

### NewClient(config *Config) (*Client, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Creates a new Consul API client with the provided configuration. Returns the client and an error if creation fails.

```APIDOC
## NewClient(config *Config) (*Client, error)

### Description
Creates a new Consul API client with the provided configuration. Returns the client and an error if creation fails.

### Method
NewClient

### Parameters
- **config** (*Config) - Required - The configuration for the client.

### Returns
- **client** (*Client) - The new client.
- **error** (error) - An error if creation fails.
```

--------------------------------

### func (s *Session) Create(se *SessionEntry, q *WriteOptions) (string, *WriteMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Creates a new session with the given session entry and write options.

```APIDOC
## Create

### Description
Creates a new session with the given session entry and write options.

### Method
Create

### Signature
func (s *Session) Create(se *SessionEntry, q *WriteOptions) (string, *WriteMeta, error)

### Parameters
- **se** (*SessionEntry) - Required - The session entry to create.
- **q** (*WriteOptions) - Optional - Write options for the request.

### Returns
- **string** - The session ID.
- **WriteMeta** - Write metadata.
- **error** - Error if creation fails.
```

--------------------------------

### BootstrapWithToken

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Used to get the initial bootstrap token or pass in the one that was provided in the API.

```APIDOC
## BootstrapWithToken

### Description
Used to get the initial bootstrap token or pass in the one that was provided in the API.

### Method
func (a *ACL) BootstrapWithToken(btoken string) (*ACLToken, *WriteMeta, error)

### Parameters
- **btoken** (string) - Required - The bootstrap token to use.

### Returns
- **ACLToken** - The bootstrap token.
- **WriteMeta** - Metadata about the write operation.
- **error** - An error if the operation failed.
```

--------------------------------

### PreparedQuery.List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Lists all prepared queries. It returns a list of query definitions and query metadata, or an error.

```APIDOC
## PreparedQuery.List

### Description
Lists all prepared queries. It returns a list of query definitions and query metadata, or an error.

### Method
List

### Signature
func (c *PreparedQuery) List(q *QueryOptions) ([]*PreparedQueryDefinition, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **definitions** ([]*PreparedQueryDefinition) - A list of query definitions.
- **queryMeta** (*QueryMeta) - Query metadata.
- **error** - An error if the operation failed.
```

--------------------------------

### func (*PreparedQuery) List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Fetches all prepared queries. Always requires a management token.

```APIDOC
## func (*PreparedQuery) List

### Description
List is used to fetch all the prepared queries (always requires a management token).

### Signature
func (c *PreparedQuery) List(q *QueryOptions) ([]*PreparedQueryDefinition, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **PreparedQueryDefinition** ([]*PreparedQueryDefinition) - The list of prepared query definitions.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** (error) - Error if any.
```

--------------------------------

### Peerings.Establish

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Establishes a peering with a remote cluster. Returns the establishment response and write metadata.

```APIDOC
## Peerings.Establish

### Description
Establishes a peering with a remote cluster.

### Method
Establish

### Signature
func (p *Peerings) Establish(ctx context.Context, i PeeringEstablishRequest, wq *WriteOptions) (*PeeringEstablishResponse, *WriteMeta, error)

### Parameters
- **ctx** (context.Context) - Required - The context for the request.
- **i** (PeeringEstablishRequest) - Required - The peering establishment request.
- **wq** (*WriteOptions) - Required - Write options for the request.

### Returns
- **PeeringEstablishResponse** (*PeeringEstablishResponse) - The response from establishing the peering.
- **WriteMeta** (*WriteMeta) - Write metadata.
- **error** (error) - An error if the operation failed.
```

--------------------------------

### Raw.Query

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Performs a GET request against an endpoint and deserializes the response into an interface using standard Consul conventions.

```APIDOC
## GET [endpoint]

### Description
Query is used to do a GET request against an endpoint and deserialize the response into an interface using standard Consul conventions.

### Method
GET

### Endpoint
[endpoint]

### Parameters
#### Path Parameters
- **endpoint** (string) - Required - The endpoint to send the GET request to.

#### Query Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Response
#### Success Response
- **out** (interface{}) - The deserialized response.
- **QueryMeta** (*QueryMeta) - Query metadata for the request.
- **error** (error) - Error if the request fails.
```

--------------------------------

### func (p *Plan) Run(address string) error

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/watch

Run is used to run a watch plan.

```APIDOC
## func (p *Plan) Run

### Description
Run is used to run a watch plan.

### Signature
```go
func (p *Plan) Run(address string) error
```

### Parameters
- **address** (string) - Required - The address of the Consul agent.

### Returns
- **error** - An error if the plan fails to run.
```

--------------------------------

### func (*DiscoveryChain) Get

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Queries the discovery-chain endpoints to retrieve a compiled discovery chain for a given service name.

```APIDOC
## func (*DiscoveryChain) Get

### Description
Get queries the discovery-chain endpoints to retrieve a compiled discovery chain for a given service name.

### Method
Get

### Signature
func (d *DiscoveryChain) Get(name string, opts *DiscoveryChainOptions, q *QueryOptions) (*DiscoveryChainResponse, *QueryMeta, error)

### Parameters
- **name** (string) - Required - The name of the service.
- **opts** (*DiscoveryChainOptions) - Optional - Options for the discovery chain query.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Return Values
- **DiscoveryChainResponse** (*DiscoveryChainResponse) - The response containing the compiled discovery chain.
- **QueryMeta** (*QueryMeta) - Metadata about the query.
- **error** (error) - An error if the operation fails.
```

--------------------------------

### func (*Config) GenerateEnv() []string

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Generates environment variables from the configuration.

```APIDOC
## func (*Config) GenerateEnv() []string

### Description
Generates environment variables from the configuration.

### Signature
func (c *Config) GenerateEnv() []string

### Returns
- []string - The generated environment variables.
```

--------------------------------

### func (*Client) Headers() http.Header

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the current set of headers used for requests. This returns a copy; to modify it call AddHeader or SetHeaders.

```APIDOC
## func (*Client) Headers() http.Header

### Description
Gets the current set of headers used for requests. This returns a copy; to modify it call AddHeader or SetHeaders.

### Method
Headers

### Signature
func (c *Client) Headers() http.Header

### Returns
- http.Header - a copy of the current headers
```

--------------------------------

### SetupTLSConfig

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

TLSConfig is used to generate a TLSClientConfig that's useful for talking to Consul using TLS.

```APIDOC
## SetupTLSConfig

### Description
TLSConfig is used to generate a TLSClientConfig that's useful for talking to Consul using TLS.

### Function Signature
func SetupTLSConfig(tlsConfig *TLSConfig) (*tls.Config, error)

### Parameters
- **tlsConfig** (*TLSConfig) - Required - The TLS configuration to use.

### Returns
- **tls.Config** - The generated TLS client config.
- **error** - An error if the config could not be generated.
```

--------------------------------

### ServiceOp

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

ServiceOp is a string type representing possible operations available in a transaction. It includes constants for get, set, cas, delete, and delete-cas operations.

```APIDOC
## ServiceOp

### Description
ServiceOp constants give possible operations available in a transaction.

### Type
string

### Constants
- **ServiceGet** (string) - "get" - Get operation.
- **ServiceSet** (string) - "set" - Set operation.
- **ServiceCAS** (string) - "cas" - Compare-and-swap operation.
- **ServiceDelete** (string) - "delete" - Delete operation.
- **ServiceDeleteCAS** (string) - "delete-cas" - Delete with compare-and-swap operation.
```

--------------------------------

### PreparedQuery.Create

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Creates a new prepared query. Returns the ID of the new query and write metadata.

```APIDOC
## PreparedQuery.Create

### Description
Creates a new prepared query. The ID of the new query is returned.

### Method
Create

### Signature
func (c *PreparedQuery) Create(query *PreparedQueryDefinition, q *WriteOptions) (string, *WriteMeta, error)

### Parameters
- **query** (*PreparedQueryDefinition) - Required - The prepared query definition.
- **q** (*WriteOptions) - Required - Write options for the request.

### Returns
- **string** (string) - The ID of the new query.
- **WriteMeta** (*WriteMeta) - Write metadata.
- **error** (error) - An error if the operation failed.
```

--------------------------------

### Event.List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Gets the most recent events an agent has received. This list can be optionally filtered by the name. This endpoint supports quasi-blocking queries. The index is not monotonic, nor does it provide LastContact or KnownLeader.

```APIDOC
## func (*Event) List

### Description
List is used to get the most recent events an agent has received. This list can be optionally filtered by the name. This endpoint supports quasi-blocking queries. The index is not monotonic, nor does it provide LastContact or KnownLeader.

### Method
List

### Signature
func (e *Event) List(name string, q *QueryOptions) ([]*UserEvent, *QueryMeta, error)

### Parameters
- **e** (*Event) - The receiver.
- **name** (string) - The event name filter.
- **q** (*QueryOptions) - The query options.

### Returns
- **[]*UserEvent** - A list of user events.
- **QueryMeta** - The query metadata.
- **error** - An error if the operation fails.
```

--------------------------------

### Catalog.Service(service, tag string, q *QueryOptions)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Returns the catalog services for a given service and tag.

```APIDOC
## Catalog.Service(service, tag string, q *QueryOptions)

### Description
Returns the catalog services for a given service and tag.

### Method
Service

### Signature
func (c *Catalog) Service(service, tag string, q *QueryOptions) ([]*CatalogService, *QueryMeta, error)

### Parameters
- **service** (string) - Required - The service name.
- **tag** (string) - Required - The tag to filter by.
- **q** (*QueryOptions) - Optional - Query options for the request.

### Response
- **[]*CatalogService** - List of catalog services.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### Namespaces.List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Lists all namespaces. Requires query options, returns a slice of namespaces and query metadata.

```APIDOC
## Namespaces.List

### Description
Lists all namespaces.

### Method
List

### Signature
func (n *Namespaces) List(q *QueryOptions) ([]*Namespace, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **[]*Namespace** - List of namespaces.
- **QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### Connect.IntentionUpsert(ixn *Intention, q *WriteOptions) (*WriteMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api

Creates or updates an intention.

```APIDOC
## Connect.IntentionUpsert(ixn *Intention, q *WriteOptions) (*WriteMeta, error)

### Description
Creates or updates an intention.

### Method
IntentionUpsert

### Parameters
- **ixn** (*Intention) - Required - The intention to upsert.
- **q** (*WriteOptions) - Required - Write options.

### Returns
- **meta** (*WriteMeta) - Write metadata.
- **error** (error) - An error if the operation fails.
```

--------------------------------

### func (*ACL) PolicyList(q *QueryOptions) ([]*ACLPolicyListEntry, *QueryMeta, error)

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Retrieves a listing of all ACL policies. The listing does not include the rules for any policy; use PolicyRead to get the full policy details.

```APIDOC
## func (*ACL) PolicyList

### Description
Retrieves a listing of all ACL policies. The listing does not include the rules for any policy; use PolicyRead to get the full policy details.

### Signature
func (a *ACL) PolicyList(q *QueryOptions) ([]*ACLPolicyListEntry, *QueryMeta, error)

### Parameters
- **q** (*QueryOptions) - Optional - Query options for the request.

### Returns
- **[]*ACLPolicyListEntry** - List of ACL policy entries.
- ***QueryMeta** - Query metadata.
- **error** - Error if any.
```

--------------------------------

### ConfigEntries.List

Source: https://pkg.go.dev/github.com/hashicorp/consul/api/v2

Lists configuration entries of a given kind.

```APIDOC
## ConfigEntries.List

### Description
Lists configuration entries of a given kind.

### Method
List

### Signature
func (conf *ConfigEntries) List(kind string, q *QueryOptions) ([]ConfigEntry, *QueryMeta, error)

### Parameters
- **kind** (string) - Required - The kind of configuration entries.
- **q** (*QueryOptions) - Optional - Query options.

### Returns
- **[]ConfigEntry** - List of configuration entries.
- **QueryMeta** (*QueryMeta) - Query metadata.
- **error** - Error if any.

```
Tokens:
Raw