1"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([["16474"],{72412(e,t,s){s.r(t),s.d(t,{metadata:()=>n,default:()=>p,frontMatter:()=>i,contentTitle:()=>a,toc:()=>l,assets:()=>r});var n=JSON.parse('{"id":"api/system/step-down","title":"/sys/step-down","description":"The `/sys/step-down` endpoint causes the node to give up active status.","source":"@site/content/docs/api/system/step-down.mdx","sourceDirName":"api/system","slug":"/api/system/step-down","permalink":"/docs/next/api/system/step-down","draft":false,"unlisted":false,"editUrl":"https://github.com/openbao/openbao/blob/main/website/content/docs/api/system/step-down.mdx","tags":[],"version":"current","frontMatter":{"description":"The `/sys/step-down` endpoint causes the node to give up active status."},"sidebar":"api","previous":{"title":"/sys/seal-status","permalink":"/docs/next/api/system/seal-status"},"next":{"title":"Overview","permalink":"/docs/next/api/system/storage/"}}'),o=s(94686),d=s(44812);let i={description:"The `/sys/step-down` endpoint causes the node to give up active status."},a="/sys/step-down",r={},l=[{value:"Step down leader",id:"step-down-leader",level:2},{value:"Sample request",id:"sample-request",level:3}];function c(e){let t={code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,d.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(t.header,{children:(0,o.jsx)(t.h1,{id:"sysstep-down",children:(0,o.jsx)(t.code,{children:"/sys/step-down"})})}),"\n",(0,o.jsxs)(t.p,{children:["The ",(0,o.jsx)(t.code,{children:"/sys/step-down"})," endpoint causes the node to give up active status."]}),"\n",(0,o.jsx)(t.h2,{id:"step-down-leader",children:"Step down leader"}),"\n",(0,o.jsxs)(t.p,{children:["This endpoint forces the node to give up active status. If the node does not\nhave active status, this endpoint does nothing. Note that the node will sleep\nfor ten seconds before attempting to grab the active lock again, but if no\nstandby nodes grab the active lock in the interim, the same node may become the\nactive node again. Requires a token with ",(0,o.jsx)(t.code,{children:"root"})," policy or ",(0,o.jsx)(t.code,{children:"sudo"})," capability on\nthe path."]}),"\n",(0,o.jsxs)(t.table,{children:[(0,o.jsx)(t.thead,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.th,{style:{textAlign:"left"},children:"Method"}),(0,o.jsx)(t.th,{style:{textAlign:"left"},children:"Path"})]})}),(0,o.jsx)(t.tbody,{children:(0,o.jsxs)(t.tr,{children:[(0,o.jsx)(t.td,{style:{textAlign:"left"},children:(0,o.jsx)(t.code,{children:"POST"})}),(0,o.jsx)(t.td,{style:{textAlign:"left"},children:(0,o.jsx)(t.code,{children:"/sys/step-down"})})]})})]}),"\n",(0,o.jsx)(t.h3,{id:"sample-request",children:"Sample request"}),"\n",(0,o.jsx)(t.pre,{children:(0,o.jsx)(t.code,{className:"language-shell-session",children:'$ curl \\\n --header "X-Vault-Token: ..." \\\n --request POST \\\n http://127.0.0.1:8200/v1/sys/step-down\n'})})]})}function p(e={}){let{wrapper:t}={...(0,d.R)(),...e.components};return t?(0,o.jsx)(t,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},44812(e,t,s){s.d(t,{R:()=>i,x:()=>a});var n=s(92990);let o={},d=n.createContext(o);function i(e){let t=n.useContext(d);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:i(e.components),n.createElement(d.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.