Consul Service Definition

Schema for a service definition registered with the Consul agent or catalog.

ACLConfigurationHealth CheckingKey-Value StoreMulti-DatacenterOpen-SourceService DiscoveryService Mesh

Properties

Name	Type	Description
ID	string
Name	string
Tags	array
Address	string
TaggedAddresses	object
Meta	object
Port	integer
Kind	string
Proxy	object
Connect	object
Weights	object
Check	object
Checks	array
EnableTagOverride	boolean
Namespace	string
Partition	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/consul/refs/heads/main/json-schema/consul-service-schema.json",
  "title": "Consul Service Definition",
  "description": "Schema for a service definition registered with the Consul agent or catalog.",
  "type": "object",
  "properties": {
    "ID": { "type": "string" },
    "Name": { "type": "string" },
    "Tags": {
      "type": "array",
      "items": { "type": "string" }
    },
    "Address": { "type": "string" },
    "TaggedAddresses": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "Address": { "type": "string" },
          "Port": { "type": "integer" }
        }
      }
    },
    "Meta": {
      "type": "object",
      "additionalProperties": { "type": "string" }
    },
    "Port": { "type": "integer", "minimum": 1, "maximum": 65535 },
    "Kind": {
      "type": "string",
      "enum": ["", "connect-proxy", "mesh-gateway", "ingress-gateway", "terminating-gateway"]
    },
    "Proxy": { "type": "object" },
    "Connect": { "type": "object" },
    "Weights": {
      "type": "object",
      "properties": {
        "Passing": { "type": "integer" },
        "Warning": { "type": "integer" }
      }
    },
    "Check": { "$ref": "#/definitions/HealthCheck" },
    "Checks": {
      "type": "array",
      "items": { "$ref": "#/definitions/HealthCheck" }
    },
    "EnableTagOverride": { "type": "boolean" },
    "Namespace": { "type": "string" },
    "Partition": { "type": "string" }
  },
  "required": ["Name"],
  "definitions": {
    "HealthCheck": {
      "type": "object",
      "properties": {
        "CheckID": { "type": "string" },
        "Name": { "type": "string" },
        "Notes": { "type": "string" },
        "Status": {
          "type": "string",
          "enum": ["passing", "warning", "critical", "maintenance"]
        },
        "HTTP": { "type": "string", "format": "uri" },
        "TCP": { "type": "string" },
        "gRPC": { "type": "string" },
        "Method": { "type": "string" },
        "Header": {
          "type": "object",
          "additionalProperties": {
            "type": "array",
            "items": { "type": "string" }
          }
        },
        "TLSSkipVerify": { "type": "boolean" },
        "Interval": { "type": "string" },
        "Timeout": { "type": "string" },
        "DeregisterCriticalServiceAfter": { "type": "string" }
      }
    }
  }
}

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-service"

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.

GitHub Google LinkedIn

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