From ab4c8189b17690c6d433580837cadfb527b3f70a Mon Sep 17 00:00:00 2001 From: larrytamnjong Date: Tue, 3 Dec 2024 08:07:47 +0100 Subject: [PATCH] update supported API's table to reflect issue #366 --- docs/docs/2-guides/3-supported-apis.mdx | 191 +++++++++++++++--------- 1 file changed, 121 insertions(+), 70 deletions(-) diff --git a/docs/docs/2-guides/3-supported-apis.mdx b/docs/docs/2-guides/3-supported-apis.mdx index 2415040b..abeca60d 100644 --- a/docs/docs/2-guides/3-supported-apis.mdx +++ b/docs/docs/2-guides/3-supported-apis.mdx @@ -9,73 +9,124 @@ 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 | โœ… | -| | 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} | โœ… | +| 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 | โœ… | +| **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 | โœ… | +| | 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 | โœ… |