{
  "opencollection": "1.0.0",
  "info": {
    "name": "HashiCorp Consul HTTP ACL Catalog API",
    "version": "1.18.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Consul-Token",
      "value": "{{X-Consul-Token}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Catalog",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Register entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost:8500/v1/catalog/register",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Registers or updates entries in the catalog (low-level)."
        },
        {
          "info": {
            "name": "Deregister entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost:8500/v1/catalog/deregister",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Directly removes entries from the catalog."
        },
        {
          "info": {
            "name": "List datacenters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8500/v1/catalog/datacenters"
          },
          "docs": "Returns the list of all known datacenters sorted by estimated round trip time."
        },
        {
          "info": {
            "name": "List nodes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8500/v1/catalog/nodes",
            "params": [
              {
                "name": "dc",
                "value": "",
                "type": "query",
                "description": "Datacenter to query (defaults to agent's datacenter)"
              },
              {
                "name": "near",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the nodes registered in a given datacenter."
        },
        {
          "info": {
            "name": "List services",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8500/v1/catalog/services",
            "params": [
              {
                "name": "dc",
                "value": "",
                "type": "query",
                "description": "Datacenter to query (defaults to agent's datacenter)"
              },
              {
                "name": "ns",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the services registered in a given datacenter."
        },
        {
          "info": {
            "name": "List nodes for a service",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8500/v1/catalog/service/:serviceName",
            "params": [
              {
                "name": "serviceName",
                "value": "",
                "type": "path"
              },
              {
                "name": "dc",
                "value": "",
                "type": "query",
                "description": "Datacenter to query (defaults to agent's datacenter)"
              },
              {
                "name": "tag",
                "value": "",
                "type": "query"
              },
              {
                "name": "near",
                "value": "",
                "type": "query"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the nodes providing a given service in a datacenter."
        },
        {
          "info": {
            "name": "List services for a node",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:8500/v1/catalog/node/:node",
            "params": [
              {
                "name": "node",
                "value": "",
                "type": "path"
              },
              {
                "name": "dc",
                "value": "",
                "type": "query",
                "description": "Datacenter to query (defaults to agent's datacenter)"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns the node's registered services."
        }
      ]
    }
  ],
  "bundled": true
}