From 32e82b9294f8cdec41273e94d556bb5b980c909b Mon Sep 17 00:00:00 2001
From: Fortunate Omonuwa <omonuwafortunate@gmail.com>
Date: Fri, 14 Mar 2025 13:55:38 +0100
Subject: [PATCH 1/2] update supported APIs table
---
docs/docs/2-guides/3-supported-apis.mdx | 241 ++++++++++++------------
1 file changed, 121 insertions(+), 120 deletions(-)
diff --git a/docs/docs/2-guides/3-supported-apis.mdx b/docs/docs/2-guides/3-supported-apis.mdx
index abeca60dc..ee42014e6 100644
--- a/docs/docs/2-guides/3-supported-apis.mdx
+++ b/docs/docs/2-guides/3-supported-apis.mdx
@@ -1,132 +1,133 @@
---
title: Supported APIs
---
-import {ConsulAPIBadge} from "@site/src/components/CustomBadge";
-<ConsulAPIBadge inline={false}/>
+import { ConsulAPIBadge } from "@site/src/components/CustomBadge";
-*This version indicates the version of Consul API that is fully supported. Recent versions may still work, but with some missing features.*
+<ConsulAPIBadge inline={false} />
+
+_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 |
-|---------------------------------|---------------------------------------------------------|------------------------------------------------|---------------------------|
-| **Admin Partition** | Create a Partition | PUT v1/partition | ๐ง |
-| | Read a Partition | GET v1/partition/:name | โ |
-| | Update a Partition | PUT v1/partition/:name | โ |
-| | Delete a Partition | DELETE v1/partition/:name | โ |
-| | List all Partitions | GET v1/partitions | โ |
-| **Agent** | Retrieve host information | GET v1/agent/host | โ
|
-| | 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 | โ
|
-| | View Metrics | GET v1/agent/metrics | โ
|
-| | Stream Logs | GET v1/agent/monitor | โ
|
-| | Join Agent | PUT v1/agent/join/:address | โ
|
-| | Graceful Leave and Shutdown | PUT v1/agent/leave | โ
|
-| | Force Leave and Shutdown | PUT v1/agent/force-leave/:node | โ
|
-| **Agent-Checks** | List Checks | GET v1/agent/checks | โ
|
-| | Register Check | PUT v1/agent/check/register | โ
|
-| | Deregister Check | PUT v1/agent/check/deregister/:check_id | โ
|
-| | TTL Check Pass | PUT v1/agent/check/pass/:check_id | โ
|
-| | TTL Check Warn | PUT v1/agent/check/warn/:check_id | โ
|
-| | TTL Check Fail | PUT v1/agent/check/fail/:check_id | โ
|
-| | TTL Check Update | PUT /agent/check/update/:check_id | โ
|
-| **Agent-Services** | List Services | GET v1/agent/services | โ
|
-| | Get Service Configuration | GET v1/agent/service/:service_id | โ
|
-| | Get local service health | GET v1/agent/health/service/name/:service_name | โ
|
-| | Get local service health by ID | GET v1/agent/health/service/id/:service_id | โ
|
-| | Register Service | PUT v1/agent/service/register | โ
|
-| | Deregister Service | PUT v1/agent/service/deregister/:service_id | โ
|
-| | Enable Maintenance Mode | PUT v1/agent/service/maintenance/:service_id | โ
|
-| **Connect** | Authorize | POST v1/agent/connect/authorize | โ
|
-| | Certificate Authority (CA) Roots | GET v1/agent/connect/ca/roots | โ
|
-| | Service Leaf Certificate | GET v1/agent/connect/ca/leaf/:service | โ
|
-| **Catalog** | Register Entity | PUT v1/catalog/register | โ
|
-| | Deregister Entity | PUT v1/catalog/deregister | โ
|
-| | List Datacenters | GET v1/catalog/datacenters | โ
|
-| | List Nodes | GET v1/catalog/nodes | โ
|
-| | List Services | GET v1/catalog/services | โ
|
-| | List Nodes for Service | GET v1/catalog/service/:service | โ
|
-| | Retrieve Map of Services for a Node | GET v1/catalog/node/:node | โ
|
-| | List Services for Node | GET v1/catalog/node-services/:node | โ
|
-| | List Services for Gateway | GET v1/catalog/gateway-services/:gateway | โ
|
-| **Config** | Apply Configuration | PUT v1/config | โ
|
-| | Get Configuration | GET v1/config/:kind/:name | โ
|
-| | List Configurations | GET v1/config/:kind/:name | โ
|
-| | Delete Configuration | DELETE v1/config/:kind/:name | โ
|
-| **Connect** | List CA Root Certificates | GET v1/connect/ca/roots | โ
|
-| | Get CA Configuration | GET v1/connect/ca/configuration | ๐ง |
-| | Update CA Configuration | PUT v1/connect/ca/configuration | โ |
-| | Upsert Intention by Name | PUT v1/connect/intentions/exact | โ |
-| | Create Intention with ID | POST v1/connect/intentions | โ |
-| | Update Intention by ID | PUT v1/connect/intentions/:uuid | โ |
-| | Read Specific Intention by Name | GET v1/connect/intentions/exact | โ |
-| | Read Specific Intention by ID | GET v1/connect/intentions/:uuid | โ |
-| | List Intentions | GET v1/connect/intentions | โ |
-| | Delete Intention by Name | DELETE v1/connect/intentions/exact | โ |
-| | Delete Intention by ID | DELETE v1/connect/intentions/:uuid | โ |
-| | Check Intention Result | GET v1/connect/intentions/check | โ |
-| | List Matching Intentions | GET v1/connect/intentions/match | โ |
-| **Coordinate** | Read WAN Coordinates | GET v1/coordinate/datacenters | โ
|
-| | Read LAN Coordinates for all nodes | GET v1/coordinate/nodes | โ
|
-| | Read LAN Coordinates for a node | GET v1/coordinate/node/:node | โ
|
-| | Update LAN Coordinates for a node | PUT v1/coordinate/update | โ
|
+| ------------------------------- | ------------------------------------------------------- | ---------------------------------------------- | ------------------------- |
+| **Admin Partition** | Create a Partition | PUT v1/partition | ๐ง |
+| | Read a Partition | GET v1/partition/:name | โ |
+| | Update a Partition | PUT v1/partition/:name | โ |
+| | Delete a Partition | DELETE v1/partition/:name | โ |
+| | List all Partitions | GET v1/partitions | โ |
+| **Agent** | Retrieve host information | GET v1/agent/host | โ
|
+| | 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 | โ
|
+| | View Metrics | GET v1/agent/metrics | โ
|
+| | Stream Logs | GET v1/agent/monitor | โ
|
+| | Join Agent | PUT v1/agent/join/:address | โ
|
+| | Graceful Leave and Shutdown | PUT v1/agent/leave | โ
|
+| | Force Leave and Shutdown | PUT v1/agent/force-leave/:node | โ
|
+| **Agent-Checks** | List Checks | GET v1/agent/checks | โ
|
+| | Register Check | PUT v1/agent/check/register | โ
|
+| | Deregister Check | PUT v1/agent/check/deregister/:check_id | โ
|
+| | TTL Check Pass | PUT v1/agent/check/pass/:check_id | โ
|
+| | TTL Check Warn | PUT v1/agent/check/warn/:check_id | โ
|
+| | TTL Check Fail | PUT v1/agent/check/fail/:check_id | โ
|
+| | TTL Check Update | PUT /agent/check/update/:check_id | โ
|
+| **Agent-Services** | List Services | GET v1/agent/services | โ
|
+| | Get Service Configuration | GET v1/agent/service/:service_id | โ
|
+| | Get local service health | GET v1/agent/health/service/name/:service_name | โ
|
+| | Get local service health by ID | GET v1/agent/health/service/id/:service_id | โ
|
+| | Register Service | PUT v1/agent/service/register | โ
|
+| | Deregister Service | PUT v1/agent/service/deregister/:service_id | โ
|
+| | Enable Maintenance Mode | PUT v1/agent/service/maintenance/:service_id | โ
|
+| **Connect** | Authorize | POST v1/agent/connect/authorize | โ
|
+| | Certificate Authority (CA) Roots | GET v1/agent/connect/ca/roots | โ
|
+| | Service Leaf Certificate | GET v1/agent/connect/ca/leaf/:service | โ
|
+| **Catalog** | Register Entity | PUT v1/catalog/register | โ
|
+| | Deregister Entity | PUT v1/catalog/deregister | โ
|
+| | List Datacenters | GET v1/catalog/datacenters | โ
|
+| | List Nodes | GET v1/catalog/nodes | โ
|
+| | List Services | GET v1/catalog/services | โ
|
+| | List Nodes for Service | GET v1/catalog/service/:service | โ
|
+| | Retrieve Map of Services for a Node | GET v1/catalog/node/:node | โ
|
+| | List Services for Node | GET v1/catalog/node-services/:node | โ
|
+| | List Services for Gateway | GET v1/catalog/gateway-services/:gateway | โ
|
+| **Config** | Apply Configuration | PUT v1/config | โ
|
+| | Get Configuration | GET v1/config/:kind/:name | โ
|
+| | List Configurations | GET v1/config/:kind/:name | โ
|
+| | Delete Configuration | DELETE v1/config/:kind/:name | โ
|
+| **Connect** | List CA Root Certificates | GET v1/connect/ca/roots | โ
|
+| | Get CA Configuration | GET v1/connect/ca/configuration | ๐ง |
+| | Update CA Configuration | PUT v1/connect/ca/configuration | โ |
+| | Upsert Intention by Name | PUT v1/connect/intentions/exact | โ
|
+| | Create Intention with ID | POST v1/connect/intentions | ๐ (Deprecated in 1.10.0) |
+| | Update Intention by ID | PUT v1/connect/intentions/:uuid | ๐ (Deprecated in 1.10.0) |
+| | Read Specific Intention by Name | GET v1/connect/intentions/exact | โ
|
+| | Read Specific Intention by ID | GET v1/connect/intentions/:uuid | ๐ (Deprecated in 1.10.0) |
+| | List Intentions | GET v1/connect/intentions | โ
|
+| | Delete Intention by Name | DELETE v1/connect/intentions/exact | โ
|
+| | Delete Intention by ID | DELETE v1/connect/intentions/:uuid | ๐ (Deprecated in 1.10.0) |
+| | Check Intention Result | GET v1/connect/intentions/check | โ
|
+| | List Matching Intentions | GET v1/connect/intentions/match | โ
|
+| **Coordinate** | Read WAN Coordinates | GET v1/coordinate/datacenters | โ
|
+| | Read LAN Coordinates for all nodes | GET v1/coordinate/nodes | โ
|
+| | Read LAN Coordinates for a node | GET v1/coordinate/node/:node | โ
|
+| | Update LAN Coordinates for a node | PUT v1/coordinate/update | โ
|
| **Discovery Chain** | Read Compiled Discovery Chain | GET v1/discovery-chain/:service | โ
|
-| | POST v1/discovery-chain/:service | POST v1/discovery-chain/:service |โ
|
-| **Events** | Fire Event | PUT v1/event/fire/:name | โ
|
-| | List Events | GET v1/event/list | โ
|
-| **Health** | List Checks for Node | GET v1/health/node/:node | โ
|
-| | List Checks for Service | GET v1/health/checks/:service | โ
|
-| | List Nodes for Service | GET v1/health/service/:service | โ
|
-| | List Nodes for Connect-capable Service | GET v1/health/connect/:service | โ
|
-| | List Nodes for Ingress Gateways Associated to a Service | GET v1/health/ingress/:service | โ
|
-| | 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 v1/kv/:key | โ
|
-| **Operator-Area** | Create Network Area | POST v1/operator/area | โ
|
-| | List Network Areas | GET v1/operator/area |โ
|
-| | Update Network Area | PUT v1/operator/area/:uuid | โ
|
-| | List Specific Network Area | GET v1/operator/area/:uuid |โ
|
-| | Delete Network Area | DELETE v1/operator/area/:uuid |โ
|
-| | Join Network Area | PUT v1/operator/area/:uuid/join | ๐ง |
-| | List Network Area Members | GET v1/operator/area/:uuid/members | โ |
-| **Autopilot Operator** | Read Configuration | GET v1/operator/autopilot/configuration | โ |
-| | Update Configuration | PUT v1/operator/autopilot/configuration | โ |
-| | Read Health | GET v1/operator/autopilot/health | โ |
-| | Read the Autopilot State | GET v1/operator/autopilot/state | โ |
-| **Keyring Operator** | List Gossip Encryption Keys | GET v1/operator/keyring | โ
|
-| | Add New Gossip Encryption Key | POST v1/operator/keyring | โ
|
-| | Change Primary Gossip Encryption Key | PUT v1/operator/keyring | โ
|
-| | Delete Gossip Encryption Key | DELETE v1/operator/keyring | โ
|
-| **License - Operator** | Getting the Consul License | GET v1/operator/license | โ
|
+| | POST v1/discovery-chain/:service | POST v1/discovery-chain/:service | โ
|
+| **Events** | Fire Event | PUT v1/event/fire/:name | โ
|
+| | List Events | GET v1/event/list | โ
|
+| **Health** | List Checks for Node | GET v1/health/node/:node | โ
|
+| | List Checks for Service | GET v1/health/checks/:service | โ
|
+| | List Nodes for Service | GET v1/health/service/:service | โ
|
+| | List Nodes for Connect-capable Service | GET v1/health/connect/:service | โ
|
+| | List Nodes for Ingress Gateways Associated to a Service | GET v1/health/ingress/:service | โ
|
+| | 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 v1/kv/:key | โ
|
+| **Operator-Area** | Create Network Area | POST v1/operator/area | โ
|
+| | List Network Areas | GET v1/operator/area | โ
|
+| | Update Network Area | PUT v1/operator/area/:uuid | โ
|
+| | List Specific Network Area | GET v1/operator/area/:uuid | โ
|
+| | Delete Network Area | DELETE v1/operator/area/:uuid | โ
|
+| | Join Network Area | PUT v1/operator/area/:uuid/join | ๐ง |
+| | List Network Area Members | GET v1/operator/area/:uuid/members | โ |
+| **Autopilot Operator** | Read Configuration | GET v1/operator/autopilot/configuration | โ |
+| | Update Configuration | PUT v1/operator/autopilot/configuration | โ |
+| | Read Health | GET v1/operator/autopilot/health | โ |
+| | Read the Autopilot State | GET v1/operator/autopilot/state | โ |
+| **Keyring Operator** | List Gossip Encryption Keys | GET v1/operator/keyring | โ
|
+| | Add New Gossip Encryption Key | POST v1/operator/keyring | โ
|
+| | Change Primary Gossip Encryption Key | PUT v1/operator/keyring | โ
|
+| | Delete Gossip Encryption Key | DELETE v1/operator/keyring | โ
|
+| **License - Operator** | Getting the Consul License | GET v1/operator/license | โ
|
| | Updating the Consul License | PUT v1/operator/license | ๐ (Deprecated in 1.10.0) |
| | Resetting the Consul License | DELETE v1/operator/license | ๐ (Deprecated in 1.10.0) |
-| **Raft Operator** | Read Configuration | GET v1/operator/raft/configuration | โ
|
-| | Delete Raft Peer | DELETE v1/operator/raft/peer | โ
|
-| **Network Segments - Operator** | List Network Segments | GET v1/operator/segment | โ
|
-| **Namespace** | Create a Namespace | PUT v1/namespace | โ
|
-| | Read a Namespace | GET v1/namespace/:name | โ
|
-| | Update a Namespace | PUT v1/namespace/:name | โ
|
-| | Delete a Namespace | DELETE v1/namespace/:name | โ
|
-| | List all Namespaces | GET v1/namespaces | โ
|
-| **Prepared Query** | Create Prepared Query | POST v1/query | โ
|
-| | List Prepared Queries | GET v1/query | โ
|
-| | Update Prepared Query | PUT v1/query/:uuid | โ
|
-| | Read Prepared Query | GET v1/query/:uuid | โ
|
-| | Delete Prepared Query | DELETE v1/query/:uuid | โ
|
-| | Execute Prepared Query | GET v1/query/:uuid/execute | โ
|
-| | Explain Prepared Query | GET v1/query/:uuid/explain | โ
|
-| **Session** | Create Session | PUT v1/session/create | โ
|
-| | Delete Session | PUT v1/session/destroy/:uuid | โ
|
-| | Read Session | GET v1/session/info/:uuid | โ
|
-| | List Sessions for Node | GET v1/session/node/:node | โ
|
-| | List Sessions | GET v1/session/list | โ
|
-| | Renew Session | PUT v1/session/renew/:uuid | โ
|
-| **Snapshot** | Generate Snapshot | GET v1/snapshot | โ
|
-| | Restore Snapshot | PUT v1/snapshot | โ
|
-| **Status** | Get Raft Leader | GET v1/status/leader | โ
|
-| | List Raft Peers | GET v1/status/peers | โ
|
-| **Transactions** | Create Transaction | PUT v1/txn | โ
|
+| **Raft Operator** | Read Configuration | GET v1/operator/raft/configuration | โ
|
+| | Delete Raft Peer | DELETE v1/operator/raft/peer | โ
|
+| **Network Segments - Operator** | List Network Segments | GET v1/operator/segment | โ
|
+| **Namespace** | Create a Namespace | PUT v1/namespace | โ
|
+| | Read a Namespace | GET v1/namespace/:name | โ
|
+| | Update a Namespace | PUT v1/namespace/:name | โ
|
+| | Delete a Namespace | DELETE v1/namespace/:name | โ
|
+| | List all Namespaces | GET v1/namespaces | โ
|
+| **Prepared Query** | Create Prepared Query | POST v1/query | โ
|
+| | List Prepared Queries | GET v1/query | โ
|
+| | Update Prepared Query | PUT v1/query/:uuid | โ
|
+| | Read Prepared Query | GET v1/query/:uuid | โ
|
+| | Delete Prepared Query | DELETE v1/query/:uuid | โ
|
+| | Execute Prepared Query | GET v1/query/:uuid/execute | โ
|
+| | Explain Prepared Query | GET v1/query/:uuid/explain | โ
|
+| **Session** | Create Session | PUT v1/session/create | โ
|
+| | Delete Session | PUT v1/session/destroy/:uuid | โ
|
+| | Read Session | GET v1/session/info/:uuid | โ
|
+| | List Sessions for Node | GET v1/session/node/:node | โ
|
+| | List Sessions | GET v1/session/list | โ
|
+| | Renew Session | PUT v1/session/renew/:uuid | โ
|
+| **Snapshot** | Generate Snapshot | GET v1/snapshot | โ
|
+| | Restore Snapshot | PUT v1/snapshot | โ
|
+| **Status** | Get Raft Leader | GET v1/status/leader | โ
|
+| | List Raft Peers | GET v1/status/peers | โ
|
+| **Transactions** | Create Transaction | PUT v1/txn | โ
|
From a17d810b985cf0ab09cc490a2d709ef915814560 Mon Sep 17 00:00:00 2001
From: Fortunate Omonuwa <omonuwafortunate@gmail.com>
Date: Fri, 14 Mar 2025 13:59:42 +0100
Subject: [PATCH 2/2] update deprecated version
---
docs/docs/2-guides/3-supported-apis.mdx | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/docs/docs/2-guides/3-supported-apis.mdx b/docs/docs/2-guides/3-supported-apis.mdx
index ee42014e6..605ac0870 100644
--- a/docs/docs/2-guides/3-supported-apis.mdx
+++ b/docs/docs/2-guides/3-supported-apis.mdx
@@ -61,13 +61,13 @@ _This version indicates the version of Consul API that is fully supported. Recen
| | Get CA Configuration | GET v1/connect/ca/configuration | ๐ง |
| | Update CA Configuration | PUT v1/connect/ca/configuration | โ |
| | Upsert Intention by Name | PUT v1/connect/intentions/exact | โ
|
-| | Create Intention with ID | POST v1/connect/intentions | ๐ (Deprecated in 1.10.0) |
-| | Update Intention by ID | PUT v1/connect/intentions/:uuid | ๐ (Deprecated in 1.10.0) |
+| | Create Intention with ID | POST v1/connect/intentions | ๐ (Deprecated in 1.9.0) |
+| | Update Intention by ID | PUT v1/connect/intentions/:uuid | ๐ (Deprecated in 1.9.0) |
| | Read Specific Intention by Name | GET v1/connect/intentions/exact | โ
|
-| | Read Specific Intention by ID | GET v1/connect/intentions/:uuid | ๐ (Deprecated in 1.10.0) |
+| | Read Specific Intention by ID | GET v1/connect/intentions/:uuid | ๐ (Deprecated in 1.9.0) |
| | List Intentions | GET v1/connect/intentions | โ
|
| | Delete Intention by Name | DELETE v1/connect/intentions/exact | โ
|
-| | Delete Intention by ID | DELETE v1/connect/intentions/:uuid | ๐ (Deprecated in 1.10.0) |
+| | Delete Intention by ID | DELETE v1/connect/intentions/:uuid | ๐ (Deprecated in 1.9.0) |
| | Check Intention Result | GET v1/connect/intentions/check | โ
|
| | List Matching Intentions | GET v1/connect/intentions/match | โ
|
| **Coordinate** | Read WAN Coordinates | GET v1/coordinate/datacenters | โ
|