HashiCorp Consul Catalog API
Register and query services and nodes
HashiCorp Consul Catalog API is one of 14 APIs that HashiCorp Consul publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Catalog. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.
This API exposes 7 operations across 7 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.18.0.
Requests are made against 2 base URLs: http://localhost:8500/v1, https://{consul_host}:{port}/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HashiCorp Consul Catalog API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-Consul-Token (ConsulToken).
By default, every request must be authenticated.
ConsulToken— ACL token for authentication
Paths & Operations 7
Across 7 paths, the API surfaces 7 operations — 5 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Register and query services and nodes
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CatalogServiceInstance (13 properties), HealthCheck (12 properties), AgentService (9 properties), CatalogNode (8 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HashiCorp Consul 12
Other APIs HashiCorp Consul publishes across the network.