consul/website/source/docs/agent/http/coordinate.html.markdown

layout	page_title	sidebar_current	description
docs	Coordinate (HTTP)	docs-agent-http-coordinate	The Coordinate endpoint is used to query for the network coordinates for nodes in the local datacenter as well as Consul servers in the local datacenter and remote datacenters.

Coordinate HTTP Endpoint

The Coordinate endpoint is used to query for the network coordinates for nodes in the local datacenter as well as Consul servers in the local datacenter and remote datacenters.

See the Network Coordinates internals guide for more information on how these coordinates are computed, and for details on how to perform calculations with them.

The following endpoints are supported:

• /v1/coordinate/datacenters : Queries for WAN coordinates of Consul servers
• /v1/coordinate/nodes : Queries for LAN coordinates of Consul nodes

/v1/coordinate/datacenters

This endpoint is hit with a GET and returns the WAN network coordinates for all Consul servers, organized by DCs.

It returns a JSON body like this:

[
  {
    "Datacenter": "dc1",
    "AreaID": "WAN",
    "Coordinates": [
      {
        "Node": "agent-one",
        "Coord": {
          "Adjustment": 0,
          "Error": 1.5,
          "Height": 0,
          "Vec": [0,0,0,0,0,0,0,0]
        }
      }
    ]
  }
]

This endpoint serves data out of the server's local Serf data, so its results may vary as requests are handled by different servers in the cluster. In Consul Enterprise, this will include coordinates for user-added network areas as well, as indicated by the AreaID. Coordinates are only compatible within the same area.

This endpoint does not support blocking queries or any consistency modes.

<a name=""coordinate_nodes> /v1/coordinate/nodes

This endpoint is hit with a GET and returns the LAN network coordinates for all nodes in a given DC. By default, the datacenter of the agent is queried; however, the dc can be provided using the ?dc= query parameter.

It returns a JSON body like this:

[
  {
    "Node": "agent-one",
    "Coord": {
      "Adjustment": 0,
      "Error": 1.5,
      "Height": 0,
      "Vec": [0,0,0,0,0,0,0,0]
    }
  }
]

This endpoint supports blocking queries and all consistency modes.