HashiCorp Consul Snapshot API
Snapshot and restore operations
HashiCorp Consul Snapshot 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 Snapshot. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.
This API exposes 2 operations across 1 path. 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 Snapshot 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 2
Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Snapshot and restore operations
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HashiCorp Consul 12
Other APIs HashiCorp Consul publishes across the network.