HashiCorp Consul · Schema

Consul KV Pair

Schema for a key/value pair returned by the Consul KV API.

ACLConfigurationHealth CheckingKey-Value StoreMulti-DatacenterOpen-SourceService DiscoveryService Mesh

Properties

Name Type Description
Key string
Value stringnull Base64-encoded value of the key (null when not present).
Flags integer User-defined 64-bit unsigned integer associated with the entry.
CreateIndex integer
ModifyIndex integer
LockIndex integer
Session stringnull ID of the session holding the lock on this key, if any.
Namespace string
Partition string
View JSON Schema on GitHub

JSON Schema

consul-kv-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/consul/refs/heads/main/json-schema/consul-kv-schema.json",
  "title": "Consul KV Pair",
  "description": "Schema for a key/value pair returned by the Consul KV API.",
  "type": "object",
  "properties": {
    "Key": { "type": "string" },
    "Value": {
      "type": ["string", "null"],
      "description": "Base64-encoded value of the key (null when not present)."
    },
    "Flags": {
      "type": "integer",
      "description": "User-defined 64-bit unsigned integer associated with the entry."
    },
    "CreateIndex": { "type": "integer" },
    "ModifyIndex": { "type": "integer" },
    "LockIndex": { "type": "integer" },
    "Session": {
      "type": ["string", "null"],
      "description": "ID of the session holding the lock on this key, if any."
    },
    "Namespace": { "type": "string" },
    "Partition": { "type": "string" }
  },
  "required": ["Key", "CreateIndex", "ModifyIndex"]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/consul-kv"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.