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 | โ | |
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 | โ | |
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 | โ | |
Coordinates | Read WAN Coordinates | GET /v1/coordinates/datacenters | โ |
Read LAN Coordinates | GET /v1/coordinates/nodes | โ | |
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 | โ | |
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 | โ |