nomad/website/source/docs/http/agent-force-leave.html.md

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
http	HTTP API: /v1/agent/force-leave	docs-http-agent-force-leave	The '/1/agent/force-leave' endpoint is force a gossip member to leave.

/v1/agent/force-leave

The foce-leave endpoint is used to force a member of the gossip pool from the "failed" state into the "left" state. This allows the consensus protocol to remove the peer and stop attempting replication. This is only applicable for servers.

PUT / POST

Description

Force a failed gossip member into the left state.

Method

PUT or POST

URL

`/v1/agent/force-leave`

Parameters

• node required The name of the node to force leave.

Returns

A `200` status code on success.