From 7fb2d7cb084155d53c9cd6cb0a4775423cf518ed Mon Sep 17 00:00:00 2001 From: Samson Amaugo Date: Fri, 8 Dec 2023 14:22:51 +0100 Subject: [PATCH] Update 3-supported-apis.mdx (#280) --- docs/docs/2-guides/3-supported-apis.mdx | 111 +++++++++++++++--------- 1 file changed, 68 insertions(+), 43 deletions(-) diff --git a/docs/docs/2-guides/3-supported-apis.mdx b/docs/docs/2-guides/3-supported-apis.mdx index 4ef452995..6454e87d4 100644 --- a/docs/docs/2-guides/3-supported-apis.mdx +++ b/docs/docs/2-guides/3-supported-apis.mdx @@ -9,46 +9,71 @@ import {ConsulAPIBadge} from "@site/src/components/CustomBadge"; โœ… 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 | โœ… | - - +| 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/foce-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 | โœ… | +| 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 | โœ… | +| 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} | โœ… |