Supported API Table v1.21.0 #480
Description
Contributor
The following table summarizes the currently supported APIs in Consul.NET (v1.21.0)
- ✅: Implemented
- ❌: Not Implemented
- 🚧: In Progress
- 🛑: Deprecated
| Group | Endpoint | Route | Status | Access | Implementation |
|---|---|---|---|---|---|
| ACLs | Bootstrap ACL | PUT v1/acl/bootstrap |
✅ | Basic | Complete |
| Check ACL Replication | GET v1/acl/replication |
✅ | Partial (Missing "dc" query parameter) | ||
| Translate Rules | POST v1/acl/rules/translate |
🛑 | (Deprecated in 1.11.0) | ||
| Translate a Legacy Token's Rules | POST v1/acl/rules/translate/:accessor_id |
🛑 | (Deprecated in 1.11.0) | ||
| Login to Auth Method | POST v1/acl/login |
✅ | Partial (Missing a JSON Request Body) | ||
| Logout from Auth Method | POST v1/acl/logout |
✅ | Partial (Missing a JSON Request Body) | ||
| OIDC Authorization URL Request | POST v1/acl/oidc/auth-url |
❌ | Enterprise | ||
| OIDC Callback | POST v1/acl/oidc/callback |
❌ | |||
| ACL-Token | Create a Token | PUT v1/acl/token |
✅ | Basic | Partial (JSON Request Body Schema missing some properties) |
| Read a Token | GET v1/acl/token/:AccessorID |
✅ | Partial (Missing Query Parameters) | ||
| Read Self Token | GET v1/acl/token/self |
✅ | Complete | ||
| Update a Token | PUT v1/acl/token/:AccessorID |
✅ | Partial (JSON Request Body Schema missing some properties) | ||
| Clone a Token | PUT v1/acl/token/:AccessorID/clone |
✅ | Complete | ||
| List Tokens | GET v1/acl/tokens |
✅ | Partial (Missing Query Parameters) | ||
| Delete a Token | DELETE v1/acl/token/:AccessorID |
✅ | Complete | ||
| ACL-Policies | Create a Policy | PUT v1/acl/policy |
✅ | Basic | Complete |
| Read a Policy | GET v1/acl/policy/:id |
✅ | Complete | ||
| Read a Policy by Name | GET v1/acl/policy/:name |
✅ | Complete | ||
| Update a Policy | PUT v1/acl/policy/:id |
✅ | Complete | ||
| Delete a Policy | DELETE v1/acl/policy/:id |
✅ | Complete | ||
| List Policies | GET v1/acl/policies |
✅ | Complete | ||
| ACL-Templated Policies | Read a templated policy by name | GET v1/acl/templated-policy/name/:name |
✅ | Basic | Complete |
| Preview a templated policy by name | POST v1/acl/templated-policy/preview/:name |
✅ | Complete | ||
| List Templated Policies | GET v1/acl/templated-policies |
✅ | Complete | ||
| ACL-Roles | Create a Role | PUT v1/acl/role |
✅ | Basic | Partial (JSON Request Body Schema missing some properties) |
| Read a Role | GET v1/acl/role/:id |
✅ | Complete | ||
| Read a Role by Name | GET v1/acl/role/name/:name |
✅ | Complete | ||
| Update a Role | PUT v1/acl/role/:id |
✅ | Complete | ||
| Delete a Role | DELETE v1/acl/role/:id |
✅ | Complete | ||
| List Roles | GET v1/acl/roles |
✅ | Partial (Missing "policy" query parameter) | ||
| ACL-Auth Methods | Create an Auth Method | PUT v1/acl/auth-method |
✅ | Basic | Partial (JSON Request Body Schema missing some properties) |
| Read an Auth Method | GET v1/acl/auth-method/:name |
✅ | Complete | ||
| Update an Auth Method | PUT v1/acl/auth-method/:name |
✅ | Partial (JSON Request Body Schema missing some properties) | ||
| Delete an Auth Method | DELETE v1/acl/auth-method/:name |
✅ | Complete | ||
| List Auth Methods | GET v1/acl/auth-methods |
✅ | Complete | ||
| ACL-Binding Rules | Create a Binding Rule | PUT v1/acl/binding-rule |
❌ | Basic | |
| Read a Binding Rule | GET v1/acl/binding-rule/:id |
❌ | |||
| Update a Binding Rule | PUT v1/acl/binding-rule/:id |
❌ | |||
| Delete a Binding Rule | DELETE v1/acl/binding-rule/:id |
❌ | |||
| List Binding Rules | GET v1/acl/binding-rules |
❌ | |||
| Admin Partition | Create a Partition | PUT v1/partition |
❌ | Enterprise | |
| 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 |
✅ | Basic | Complete |
| Get Version Information | GET v1/agent/version |
✅ | Complete | ||
| List Members | GET v1/agent/members |
✅ | Complete | ||
| Read Configuration | GET v1/agent/self |
✅ | Complete | ||
| Reload Agent | PUT v1/agent/reload |
✅ | Complete | ||
| Enable Maintenance Mode | PUT v1/agent/maintenance |
✅ | Complete | ||
| View Metrics | GET v1/agent/metrics |
✅ | Complete | ||
| Stream Logs | GET v1/agent/monitor |
✅ | Complete | ||
| Join Agent | PUT v1/agent/join/:address |
✅ | Complete | ||
| Graceful Leave and Shutdown | PUT v1/agent/leave |
✅ | Complete | ||
| Force Leave and Shutdown | PUT v1/agent/force-leave/:node_name |
✅ | Partial (Missing query parameters) | ||
| Update ACL Tokens | PUT v1/agent/token/agent |
❌ | |||
| Update ACL Tokens | PUT v1/agent/token/default |
❌ | |||
| Agent-Checks | List Checks | GET v1/agent/checks |
✅ | Basic | Complete |
| Register Check | PUT v1/agent/check/register |
✅ | Complete | ||
| Deregister Check | PUT v1/agent/check/deregister/:check_id |
✅ | Complete | ||
| TTL Check Pass | PUT v1/agent/check/pass/:check_id |
✅ | Complete | ||
| TTL Check Warn | PUT v1/agent/check/warn/:check_id |
✅ | Complete | ||
| TTL Check Fail | PUT v1/agent/check/fail/:check_id |
✅ | Complete | ||
| TTL Check Update | PUT /agent/check/update/:check_id |
✅ | Complete | ||
| Agent-Services | List Services | GET v1/agent/services |
✅ | Basic | Complete |
| Get Service Configuration | GET v1/agent/service/:service_id |
✅ | Complete | ||
| Get local service health | GET v1/agent/health/service/name/:service_name |
✅ | Complete | ||
| Get local service health by ID | GET v1/agent/health/service/id/:service_id |
✅ | Complete | ||
| Register Service | PUT v1/agent/service/register |
✅ | Complete | ||
| Deregister Service | PUT v1/agent/service/deregister/:service_id |
✅ | Complete | ||
| Enable Maintenance Mode | PUT v1/agent/service/maintenance/:service_id |
✅ | Complete | ||
| Agent-Connect | Authorize | POST v1/agent/connect/authorize |
✅ | Basic | Complete |
| Certificate Authority (CA) Roots | GET v1/agent/connect/ca/roots |
✅ | Complete | ||
| Service Leaf Certificate | GET v1/agent/connect/ca/leaf/:service |
✅ | Complete | ||
| Catalog | Register Entity | PUT v1/catalog/register |
✅ | Basic | Partial (JSON Request Body Schema missing some properties) |
| Deregister Entity | PUT v1/catalog/deregister |
✅ | Complete | ||
| List Datacenters | GET v1/catalog/datacenters |
✅ | Complete | ||
| List Nodes | GET v1/catalog/nodes |
✅ | Partial (Missing query parameters) | ||
| List Services | GET v1/catalog/services |
✅ | Complete | ||
| List Nodes for Service | GET v1/catalog/service/:service |
✅ | Partial (Missing query parameters) | ||
| List Nodes for Mesh-capable Service | GET v1/catalog/connect/:service |
✅ | Complete | ||
| Retrieve Map of Services for a Node | GET v1/catalog/node/:node_name |
✅ | Complete | ||
| List Services for Node | GET v1/catalog/node-services/:node |
✅ | Partial (Missing query parameters) | ||
| List Services for Gateway | GET v1/catalog/gateway-services/:gateway |
✅ | Partial (Missing "dc" query parameter) | ||
| Cluster-Peering | Generate a Peering Token | POST v1/peering/token |
✅ | Basic | |
| Establish a Peering Connection | POST v1/peering/establish |
❌ | |||
| Read a Peering Connection | GET v1/peering/:name |
✅ | |||
| Delete a Peering Connection | DELETE v1/peering/:name |
✅ | |||
| List all Peerings | GET v1/peerings |
✅ | |||
| Config | Apply Configuration | PUT v1/config |
✅ | Basic | Partial (Missing query parameters) |
| Get Configuration | GET v1/config/:kind/:name |
✅ | Partial (Missing query parameters) | ||
| List Configurations | GET v1/config/:kind |
✅ | Partial (Missing query parameters) | ||
| Delete Configuration | DELETE v1/config/:kind/:name |
✅ | Partial (Missing query parameters) | ||
| Connect-Certificate Authority (CA) | List CA Root Certificates | GET v1/connect/ca/roots |
✅ | Basic | Partial (Missing "pem" query parameter) |
| Get CA Configuration | GET v1/connect/ca/configuration |
✅ | Complete | ||
| Update CA Configuration | PUT v1/connect/ca/configuration |
✅ | Complete | ||
| Connect-Intentions | Upsert Intention by Name | PUT v1/connect/intentions/exact |
✅ | Basic | Complete |
| 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 |
✅ | Complete | ||
| Read Specific Intention by ID | GET v1/connect/intentions/:uuid |
🛑 | (Deprecated in 1.9.0) | ||
| List Intentions | GET v1/connect/intentions |
✅ | Partial (Missing "filter" query parameters) | ||
| Delete Intention by Name | DELETE v1/connect/intentions/exact |
✅ | Complete | ||
| Delete Intention by ID | DELETE v1/connect/intentions/:uuid |
🛑 | (Deprecated in 1.9.0) | ||
| Check Intention Result | GET v1/connect/intentions/check |
✅ | Complete | ||
| List Matching Intentions | GET v1/connect/intentions/match |
✅ | Complete | ||
| Coordinate | Read WAN Coordinates | GET v1/coordinate/datacenters |
✅ | Basic | Complete |
| Read LAN Coordinates for all nodes | GET v1/coordinate/nodes |
✅ | Partial (Missing "dc" query parameter) | ||
| Read LAN Coordinates for a node | GET v1/coordinate/node/:node_name |
✅ | Partial (Missing "dc" query parameter) | ||
| Update LAN Coordinates for a node | PUT v1/coordinate/update |
✅ | Partial (Missing "dc" query parameter) | ||
| Discovery Chain | Read Compiled Discovery Chain | GET v1/discovery-chain/:service |
✅ | Basic | Complete |
| Read Compiled Discovery Chain | POST v1/discovery-chain/:service |
✅ | Complete | ||
| Events | Fire Event | PUT v1/event/fire/:name |
✅ | Basic | Partial (Missing "dc" query parameter) |
| List Events | GET v1/event/list |
✅ | Partial (Missing query parameters) | ||
| Exported Services | List Exported Services | GET v1/exported-services |
❌ | Basic | (Requires v1.17.3 or newer) |
| Health | List Checks for Node | GET v1/health/node/:node |
✅ | Basic | Partial (Missing query parameters) |
| List Checks for Service | GET v1/health/checks/:service |
✅ | Partial (Missing query parameters) | ||
| List Service Instances for Service | GET v1/health/service/:service |
✅ | Partial (Missing query parameters) | ||
| List Service Instances for Mesh-enabled Service | GET v1/health/connect/:service |
✅ | Partial (Missing query parameters) | ||
| List Service Instances for Ingress Gateways Associated with a Service | GET v1/health/ingress/:service |
✅ | Partial (Missing query parameters) | ||
| List Checks in State | GET v1/health/state/:state |
✅ | Partial (Missing query parameters) | ||
| KV Store | Read Key | GET v1/kv/:key |
✅ | Basic | Partial (Missing query parameters) |
| Create/Update Key | PUT v1/kv/:key |
✅ | Partial | ||
| Delete Key | DELETE v1/kv/:key |
✅ | Partial (Missing query parameters) | ||
| Operator-Area | Create Network Area | POST v1/operator/area |
✅ | Enterprise | Partial (Missing "dc" query parameter) |
| List Network Areas | GET v1/operator/area |
✅ | Partial (Missing "dc" query parameter) | ||
| Update Network Area | PUT v1/operator/area/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| List Specific Network Area | GET v1/operator/area/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Delete Network Area | DELETE v1/operator/area/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Join Network Area | PUT v1/operator/area/:uuid/join |
❌ | |||
| List Network Area Members | GET v1/operator/area/:uuid/members |
❌ | |||
| Operator-Autopilot | Read Configuration | GET v1/operator/autopilot/configuration |
✅ | Basic | Complete |
| Update Configuration | PUT v1/operator/autopilot/configuration |
✅ | Complete | ||
| Read Health | GET v1/operator/autopilot/health |
✅ | Complete | ||
| Read the Autopilot State | GET v1/operator/autopilot/state |
✅ | Complete | ||
| Operator-Keyring | List Gossip Encryption Keys | GET v1/operator/keyring |
✅ | Basic | Partial (Missing query parameters) |
| Add New Gossip Encryption Key | POST v1/operator/keyring |
✅ | Partial (Missing query parameters) | ||
| Change Primary Gossip Encryption Key | PUT v1/operator/keyring |
✅ | Partial (Missing query parameters) | ||
| Delete Gossip Encryption Key | DELETE v1/operator/keyring |
✅ | Partial (Missing query parameters) | ||
| Operator-License | Getting the Consul License | GET v1/operator/license |
✅ | Enterprise | Complete |
| 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) | ||
| Operator-Raft | Read Configuration | GET v1/operator/raft/configuration |
✅ | Basic | Partial (Missing query parameters) |
| Delete Raft Peer | DELETE v1/operator/raft/peer |
✅ | Partial (Missing "dc" query parameter) | ||
| Transfer Raft Leadership | POST v1/operator/raft/transfer-leader |
❌ | |||
| Operator-Network Segments | List Network Segments | GET v1/operator/segment |
✅ | Enterprise | Partial (Missing "dc" query parameter) |
| Operator-Usage | List Usage Operator | GET v1/operator/usage |
✅ | Basic | |
| Namespaces | Create a Namespace | PUT v1/namespace |
✅ | Enterprise | Complete |
| Read a Namespace | GET v1/namespace/:name |
✅ | Complete | ||
| Update a Namespace | PUT v1/namespace/:name |
✅ | Complete | ||
| Delete a Namespace | DELETE v1/namespace/:name |
✅ | Complete | ||
| List all Namespaces | GET v1/namespaces |
✅ | Complete | ||
| Prepared Queries | Create Prepared Query | POST v1/query |
✅ | Basic | Partial (Missing "dc" query parameter) |
| List Prepared Queries | GET v1/query |
✅ | Partial (Missing "dc" query parameter) | ||
| Update Prepared Query | PUT v1/query/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Read Prepared Query | GET v1/query/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Delete Prepared Query | DELETE v1/query/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Execute Prepared Query | GET v1/query/:uuid/execute |
✅ | Partial (Missing query parameters) | ||
| Explain Prepared Query | GET v1/query/:uuid/explain |
✅ | Partial (Missing "dc" query parameter) | ||
| Session | Create Session | PUT v1/session/create |
✅ | Basic | Partial (Missing "dc" query parameter) |
| Delete Session | PUT v1/session/destroy/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Read Session | GET v1/session/info/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| List Sessions for Node | GET v1/session/node/:node |
✅ | Partial (Missing "dc" query parameter) | ||
| List Sessions | GET v1/session/list |
✅ | Partial (Missing "dc" query parameter) | ||
| Renew Session | PUT v1/session/renew/:uuid |
✅ | Partial (Missing "dc" query parameter) | ||
| Snapshot | Generate Snapshot | GET v1/snapshot |
✅ | Basic | Partial (Missing query parameters) |
| Restore Snapshot | PUT v1/snapshot |
✅ | Partial (Missing "dc" query parameter) | ||
| Status | Get Raft Leader | GET v1/status/leader |
✅ | Basic | Partial (Missing "dc" query parameter) |
| List Raft Peers | GET v1/status/peers |
✅ | Partial (Missing "dc" query parameter) | ||
| Transactions | Create Transaction | PUT v1/txn |
✅ | Basic | Partial |