Get the mesh status
Get WireGuard mesh overlay status.
/api/v1/mesh/statustse_sessionAPI key · cookierequiredlivebooleanRead the reachability of each enrolled server now and store it, and ping each online peer for its current path, before the status.
OK
access_edgesMeshAccessEdge[]requiredShow propertiesHide properties
MeshAccessEdgedetailstringrequiredportstringrequiredreasonstringrequiredlivesyncfork-restoresource_service_idstringrequiredsource_service_namestringrequiredtarget_service_idstringrequiredtarget_service_namestringrequiredbackup_serversMeshNode[]requiredShow propertiesHide properties
MeshNodeconnectionstringrequiredenroll_statestringrequiredlast_handshakestringrequiredlast_seenstringrequirednamestringrequiredonlinebooleanOnly for the control plane: Headscale says that it is online. A server has reachable.
overlay_ipstringrequiredreachablebooleanFor a server: true when its fresh reachability note says that the console reaches it, false when it says not or the ping of a live read failed. Absent when no fresh reading tells it (the rule of the reachable field of a server), and for the control plane.
rolestringrequiredserver_idstringrequiredsincestringrequiredRFC3339 time at which the server last became reachable or unreachable: the since of its reachability note. Empty when the server has no fresh reading, when a live ping overrides a note that says reachable, and for the control plane.
tagsstring[]requiredcontrol_planeMeshNoderequiredShow propertiesHide properties
connectionstringrequiredenroll_statestringrequiredlast_handshakestringrequiredlast_seenstringrequirednamestringrequiredonlinebooleanOnly for the control plane: Headscale says that it is online. A server has reachable.
overlay_ipstringrequiredreachablebooleanFor a server: true when its fresh reachability note says that the console reaches it, false when it says not or the ping of a live read failed. Absent when no fresh reading tells it (the rule of the reachable field of a server), and for the control plane.
rolestringrequiredserver_idstringrequiredsincestringrequiredRFC3339 time at which the server last became reachable or unreachable: the since of its reachability note. Empty when the server has no fresh reading, when a live ping overrides a note that says reachable, and for the control plane.
tagsstring[]requireddcs_clustersMeshService[]requiredShow propertiesHide properties
MeshServiceidstringrequirednamestringrequirednodesMeshNode[]requiredShow propertiesHide properties
MeshNodeconnectionstringrequiredenroll_statestringrequiredlast_handshakestringrequiredlast_seenstringrequirednamestringrequiredonlinebooleanOnly for the control plane: Headscale says that it is online. A server has reachable.
overlay_ipstringrequiredreachablebooleanFor a server: true when its fresh reachability note says that the console reaches it, false when it says not or the ping of a live read failed. Absent when no fresh reading tells it (the rule of the reachable field of a server), and for the control plane.
rolestringrequiredserver_idstringrequiredsincestringrequiredRFC3339 time at which the server last became reachable or unreachable: the since of its reachability note. Empty when the server has no fresh reading, when a live ping overrides a note that says reachable, and for the control plane.
tagsstring[]requiredenabledbooleanrequiredservice_namesobjectrequiredservicesMeshService[]requiredShow propertiesHide properties
MeshServiceidstringrequirednamestringrequirednodesMeshNode[]requiredShow propertiesHide properties
MeshNodeconnectionstringrequiredenroll_statestringrequiredlast_handshakestringrequiredlast_seenstringrequirednamestringrequiredonlinebooleanOnly for the control plane: Headscale says that it is online. A server has reachable.
overlay_ipstringrequiredreachablebooleanFor a server: true when its fresh reachability note says that the console reaches it, false when it says not or the ping of a live read failed. Absent when no fresh reading tells it (the rule of the reachable field of a server), and for the control plane.
rolestringrequiredserver_idstringrequiredsincestringrequiredRFC3339 time at which the server last became reachable or unreachable: the since of its reachability note. Empty when the server has no fresh reading, when a live ping overrides a note that says reachable, and for the control plane.
tagsstring[]requiredunassignedMeshNode[]requiredShow propertiesHide properties
MeshNodeconnectionstringrequiredenroll_statestringrequiredlast_handshakestringrequiredlast_seenstringrequirednamestringrequiredonlinebooleanOnly for the control plane: Headscale says that it is online. A server has reachable.
overlay_ipstringrequiredreachablebooleanFor a server: true when its fresh reachability note says that the console reaches it, false when it says not or the ping of a live read failed. Absent when no fresh reading tells it (the rule of the reachable field of a server), and for the control plane.
rolestringrequiredserver_idstringrequiredsincestringrequiredRFC3339 time at which the server last became reachable or unreachable: the since of its reachability note. Empty when the server has no fresh reading, when a live ping overrides a note that says reachable, and for the control plane.
tagsstring[]requiredError
codestringStable code of the refusal, when the route has codes
detailsstring[]Additional detail, e.g. per-field validation failures
errorstringrequiredHuman-readable error message