Consul.NET
.NET client library for the Consul HTTP API
dotnet add package Consul
Curious about what's next? try the โก preview version
Easy to Use
Consul.NET was designed by humans, for humans. It's meant to be intuitive, simple and easy to use.
Open-Source
Consul.NET is open-source and free to use. It's developed by the community and for the community.
Production Ready
Consul.NET is used in production by many companies and is battle-tested.
Supported APIs
This version indicates the version of Consul API that is fully supported. Recent versions may still work, but with some missing features.
โ supported ยท ๐ง in progress ยท โ not supported
Group | Endpoint | Route | Status |
---|---|---|---|
Agent - Base | List Members | GET /v1/agent/members | โ |
Read Configuration | GET /v1/agent/self | โ | |
Reload Agent | PUT /v1/agent/reload | โ | |
Enable Maintenance Mode | PUT /v1/agent/maintenance | โ | |
Join Agent | GET /v1/agent/join/:id | โ | |
Graceful Leave + Shutdown | PUT /v1/agent/leave | โ | |
Force Leave + Shutdown | PUT /v1/agent/force-leave | โ | |
Read Agent Host | GET /v1/agent/host | โ | |
Read Agent Host | GET /v1/agent/version | โ | |
Agent Health by Service Id | GET /v1//agent/health/service/id/:service_id | โ | |
Agent Health by Service Name | GET /v1/agent/health/service/name/:name | โ | |
Force Leave | PUT /v1/agent/force-leave/:node | โ | |
Enable/Disable Service Maintenance | PUT /v1/agent/service/maintenance/:serviceId | โ | |
Enable/Disable Node Maintenance | PUT /v1/agent/maintenance | โ | |
Read Agent Logs | GET /v1/agent/monitor | โ | |
UpdateTokenOnce | PUT /v1/agent/token/:target | โ | |
Agent - Checks | List Checks | GET /v1/agent/checks | โ |
Register Check | PUT /v1/agent/check/register | โ | |
Deregister Check | PUT /v1/agent/check/deregister/:id | โ | |
TLL Check Pass | GET /v1/agent/check/pass/:id | โ | |
TLL Check Warn | GET /v1/agent/check/warn/:id | โ | |
TLL Check Fail | GET /v1/agent/check/fail/:id | โ | |
TLL Check Update | GET /v1/agent/check/update/:id | โ | |
Agent - Services | List Services | GET /v1/agent/services | โ |
Register Service | PUT /v1/agent/service/register | โ | |
Deregister Service | PUT /v1/agent/service/deregister/:id | โ | |
Enable Maintenance Mode | PUT /v1/agent/service/maintenance/:id | โ | |
Get a locally registered service | GET, /v1/agent/service/:serviceId | โ | |
Catalog | List Datacenters | GET /v1/catalog/datacenters | โ |
List Nodes in a given DC | GET /v1/catalog/nodes | โ | |
List Services in a given DC | GET /v1/catalog/services | โ | |
List Nodes for Service | GET /v1/catalog/service/:id | โ | |
List Services for Node | GET /v1/catalog/node/:id | โ | |
Register Catalog Item | PUT /v1/catalog/register | โ | |
Deregister Catalog Item | PUT /v1/catalog/deregister | โ | |
Node Service List | GET, /v1/catalog/node-services/:node | โ | |
Coordinates | Read WAN Coordinates | GET /v1/coordinates/datacenters | โ |
Read LAN Coordinates | GET /v1/coordinates/nodes | โ | |
Read LAN Coordinates for a node | GET /v1/coordinate/node/:node | โ | |
Events | Fire Event | PUT /v1/event/fire/:name | โ |
List Events | GET /v1/event/list | โ | |
Health | List Checks for Node | GET /v1/health/node/:id | โ |
List Checks for Service | GET /v1/health/checks/:id | โ | |
List Nodes for Service | GET /v1/health/service/:id | โ | |
List Checks in State | GET /v1/health/state/:state | โ | |
List Nodes for connect-capable service | GET /v1/health/connect/:service | โ | |
KV Store | Read Key | GET /v1/kv/:key | โ |
Create/Update Key | PUT /v1/kv/:key | โ | |
Delete Key | DELETE /v2/kv/:key | โ | |
Namespace | List Namespaces | GET /v1/namespaces | โ |
Read Namespace | GET /v1/namespace/:name | โ | |
Create Namespace | PUT /v1/namespace | โ | |
Update Namespace | PUT /v1/namespace/:name | โ | |
Delete Namespace | DELETE /v1/namespace/:name | โ | |
Session | List Session | GET /v1/session/list | โ |
Create Session | POST /v1/session/create | โ | |
Destroy Session | PUT /v1/session/destroy/:id | โ | |
Renew Session | PUT /v1/session/renew/:id | โ | |
Info Session | GET /v1/session/node/:node | โ | |
Destroy Session | PUT /v1/session/destroy/:id | โ | |
List Sessions for Node | GET /v1/session/node/:node | โ | |
Status | Status of Leader | GET /v1/status/leader | โ |
Status of Peers | GET /v1/status/peers | โ | |
Transaction | Transaction | PUT /v1/txn | โ |
Config | Retrieve a specific configuration by kind and name | GET /v1/config/{kind}/{name} | โ |
List all configuration entries of a specific kind | GET /v1/config/{kind} | โ | |
Set a new configuration entry | PUT /v1/config | โ | |
Delete a specific configuration entry by kind and name | DELETE /v1/config/{kind}/{name} | โ |