content/docs/4.11.1/admin/http/index.html - bookkeeper - Git at Google

 <!doctype html>
 <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-4.11.1 plugin-docs plugin-id-default docs-doc-id-admin/http">
 <head>
 <meta charset="UTF-8">
 <meta name="generator" content="Docusaurus v2.4.0">
 <title data-rh="true">BookKeeper Admin REST API | Apache BookKeeper</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://bookkeeper.apache.org/docs/4.11.1/admin/http"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="4.11.1"><meta data-rh="true" name="docusaurus_tag" content="docs-default-4.11.1"><meta data-rh="true" name="docsearch:version" content="4.11.1"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-4.11.1"><meta data-rh="true" property="og:title" content="BookKeeper Admin REST API | Apache BookKeeper"><meta data-rh="true" name="description" content="This document introduces BookKeeper HTTP endpoints, which can be used for BookKeeper administration."><meta data-rh="true" property="og:description" content="This document introduces BookKeeper HTTP endpoints, which can be used for BookKeeper administration."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://bookkeeper.apache.org/docs/4.11.1/admin/http"><link data-rh="true" rel="alternate" href="https://bookkeeper.apache.org/docs/4.11.1/admin/http" hreflang="en"><link data-rh="true" rel="alternate" href="https://bookkeeper.apache.org/docs/4.11.1/admin/http" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.49914aab.css">
 <link rel="preload" href="/assets/js/runtime~main.99a29ea0.js" as="script">
 <link rel="preload" href="/assets/js/main.812b2dbb.js" as="script">
 </head>
 <body class="navigation-with-keyboard">
 <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
 <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/bk-logo.svg" alt="Apache Bookkeeper" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/bk-logo.svg" alt="Apache Bookkeeper" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache BookKeeper</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/4.11.1/overview/">Documentation</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community/mailing-lists">Mailing lists</a></li><li><a class="dropdown__link" href="/community/slack">Slack</a></li><li><a href="https://github.com/apache/bookkeeper/issues" target="_blank" rel="noopener noreferrer" class="dropdown__link">Github issues<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a class="dropdown__link" href="/community/releases">Release management</a></li><li><a class="dropdown__link" href="/community/meeting">Community meetings</a></li><li><a class="dropdown__link" href="/community/contributing">Contribution guide</a></li><li><a class="dropdown__link" href="/community/coding-guide">Coding guide</a></li><li><a class="dropdown__link" href="/community/testing">Testing guide</a></li><li><a class="dropdown__link" href="/community/issue-report">Issue report guide</a></li><li><a class="dropdown__link" href="/community/release-guide">Release guide</a></li><li><a class="dropdown__link" href="/community/presentations">Presentations</a></li><li><a class="dropdown__link" href="/community/bookkeeper-proposals">BookKeeper proposals (BP)</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Project</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/project/who">Who are we?</a></li><li><a class="dropdown__link" href="/project/bylaws">Bylaws</a></li><li><a href="https://apache.org/licenses" target="_blank" rel="noopener noreferrer" class="dropdown__link">License<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a class="dropdown__link" href="/project/privacy">Privacy policy</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/4.11.1/overview/">4.11.1</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/admin/http">Next</a></li><li><a class="dropdown__link" href="/docs/admin/http">4.16.5</a></li><li><a class="dropdown__link" href="/docs/4.15.5/admin/http">4.15.5</a></li><li><a class="dropdown__link" href="/docs/4.14.8/admin/http">4.14.8</a></li><li><a class="dropdown__link" href="/docs/4.13.0/admin/http">4.13.0</a></li><li><a class="dropdown__link" href="/docs/4.12.1/admin/http">4.12.1</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/docs/4.11.1/admin/http">4.11.1</a></li><li><a class="dropdown__link" href="/docs/4.10.0/admin/http">4.10.0</a></li><li><a class="dropdown__link" href="/docs/4.9.2/admin/http">4.9.2</a></li><li><a class="dropdown__link" href="/docs/4.8.2/admin/http">4.8.2</a></li><li><a class="dropdown__link" href="/docs/4.7.3/admin/http">4.7.3</a></li><li><a class="dropdown__link" href="/docs/4.6.2/admin/http">4.6.2</a></li><li><a class="dropdown__link" href="/docs/4.5.1/overview/">4.5.1</a></li></ul></div><a class="navbar__item navbar__link" href="/releases">Download</a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebarViewport_Xe31"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/4.11.1/overview/">Overview</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/4.11.1/getting-started/installation">Getting started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/4.11.1/deployment/manual">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" aria-expanded="true" href="/docs/4.11.1/admin/bookies">Administration</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/4.11.1/admin/bookies">BookKeeper administration</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/4.11.1/admin/autorecovery">AutoRecovery</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/4.11.1/admin/metrics">Metrics collection</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/4.11.1/admin/upgrade">Upgrade</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/4.11.1/admin/http">Admin REST API</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/4.11.1/admin/decomission">Decommissioning Bookies</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/4.11.1/api/overview">API</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/4.11.1/security/overview">Security</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/4.11.1/development/protocol">Development</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" aria-expanded="false" href="/docs/4.11.1/reference/config">Reference</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><span class="theme-doc-version-badge badge badge--secondary">Version: 4.11.1</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>BookKeeper Admin REST API</h1></header><p>This document introduces BookKeeper HTTP endpoints, which can be used for BookKeeper administration.
 To use this feature, set <code>httpServerEnabled</code> to <code>true</code> in file <code>conf/bk_server.conf</code>.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="all-the-endpoints">All the endpoints<a href="#all-the-endpoints" class="hash-link" aria-label="Direct link to All the endpoints" title="Direct link to All the endpoints"></a></h2><p>Currently all the HTTP endpoints could be divided into these 5 components:</p><ol><li>Heartbeat: heartbeat for a specific bookie.</li><li>Config: doing the server configuration for a specific bookie.</li><li>Ledger: HTTP endpoints related to ledgers.</li><li>Bookie: HTTP endpoints related to bookies.</li><li>AutoRecovery: HTTP endpoints related to auto recovery.</li></ol><h2 class="anchor anchorWithStickyNavbar_LWe7" id="heartbeat">Heartbeat<a href="#heartbeat" class="hash-link" aria-label="Direct link to Heartbeat" title="Direct link to Heartbeat"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-heartbeat">Endpoint: /heartbeat<a href="#endpoint-heartbeat" class="hash-link" aria-label="Direct link to Endpoint: /heartbeat" title="Direct link to Endpoint: /heartbeat"></a></h3><ul><li>Method: GET</li><li>Description: Get heartbeat status for a specific bookie</li><li>Response: </li></ul><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr></tbody></table><h2 class="anchor anchorWithStickyNavbar_LWe7" id="config">Config<a href="#config" class="hash-link" aria-label="Direct link to Config" title="Direct link to Config"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1configserver_config">Endpoint: /api/v1/config/server_config<a href="#endpoint-apiv1configserver_config" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/config/server_config" title="Direct link to Endpoint: /api/v1/config/server_config"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description: Get value of all configured values overridden on local server config</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li><li><p>Method: PUT</p><ul><li><p>Description: Update a local server config</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">configName</td><td align="left">String</td><td align="left">Yes</td><td align="left">Configuration name(key)</td></tr><tr><td align="left">configValue</td><td align="left">String</td><td align="left">Yes</td><td align="left">Configuration value(value)</td></tr></tbody></table></li><li><p>Body: </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;configName1&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;configValue1&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;configName2&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;configValue2&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h2 class="anchor anchorWithStickyNavbar_LWe7" id="metrics">Metrics<a href="#metrics" class="hash-link" aria-label="Direct link to Metrics" title="Direct link to Metrics"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-metrics">Endpoint: /metrics<a href="#endpoint-metrics" class="hash-link" aria-label="Direct link to Endpoint: /metrics" title="Direct link to Endpoint: /metrics"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description: Get all metrics by calling <code>writeAllMetrics()</code> of <code>statsProvider</code> internally</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h2 class="anchor anchorWithStickyNavbar_LWe7" id="ledger">Ledger<a href="#ledger" class="hash-link" aria-label="Direct link to Ledger" title="Direct link to Ledger"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1ledgerdeleteledger_idledger_id">Endpoint: /api/v1/ledger/delete/?ledger_id=<!-- -->&lt;<!-- -->ledger_id<!-- -->&gt;<a href="#endpoint-apiv1ledgerdeleteledger_idledger_id" class="hash-link" aria-label="Direct link to endpoint-apiv1ledgerdeleteledger_idledger_id" title="Direct link to endpoint-apiv1ledgerdeleteledger_idledger_id"></a></h3><ol><li><p>Method: DELETE</p><ul><li><p>Description: Delete a ledger.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">ledger_id</td><td align="left">Long</td><td align="left">Yes</td><td align="left">ledger id of the ledger.</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1ledgerlistprint_metadatametadata">Endpoint: /api/v1/ledger/list/?print_metadata=<!-- -->&lt;<!-- -->metadata<!-- -->&gt;<a href="#endpoint-apiv1ledgerlistprint_metadatametadata" class="hash-link" aria-label="Direct link to endpoint-apiv1ledgerlistprint_metadatametadata" title="Direct link to endpoint-apiv1ledgerlistprint_metadatametadata"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description: List all the ledgers.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">print_metadata</td><td align="left">Boolean</td><td align="left">No</td><td align="left">whether print out metadata</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;ledgerId1&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;ledgerMetadata1&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;ledgerId2&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;ledgerMetadata2&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ...</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1ledgermetadataledger_idledger_id">Endpoint: /api/v1/ledger/metadata/?ledger_id=<!-- -->&lt;<!-- -->ledger_id<!-- -->&gt;<a href="#endpoint-apiv1ledgermetadataledger_idledger_id" class="hash-link" aria-label="Direct link to endpoint-apiv1ledgermetadataledger_idledger_id" title="Direct link to endpoint-apiv1ledgermetadataledger_idledger_id"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description: Get the metadata of a ledger.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">ledger_id</td><td align="left">Long</td><td align="left">Yes</td><td align="left">ledger id of the ledger.</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;ledgerId1&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;ledgerMetadata1&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1ledgerreadledger_idledger_idstart_entry_idstart_entry_idend_entry_idend_entry_id">Endpoint: /api/v1/ledger/read/?ledger_id=<!-- -->&lt;<!-- -->ledger_id<!-- -->&gt;<!-- -->&amp;start_entry_id=<!-- -->&lt;<!-- -->start_entry_id<!-- -->&gt;<!-- -->&amp;end_entry_id=<!-- -->&lt;<!-- -->end_entry_id<!-- -->&gt;<a href="#endpoint-apiv1ledgerreadledger_idledger_idstart_entry_idstart_entry_idend_entry_idend_entry_id" class="hash-link" aria-label="Direct link to endpoint-apiv1ledgerreadledger_idledger_idstart_entry_idstart_entry_idend_entry_idend_entry_id" title="Direct link to endpoint-apiv1ledgerreadledger_idledger_idstart_entry_idstart_entry_idend_entry_idend_entry_id"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description: Read a range of entries from ledger.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">ledger_id</td><td align="left">Long</td><td align="left">Yes</td><td align="left">ledger id of the ledger.</td></tr><tr><td align="left">start_entry_id</td><td align="left">Long</td><td align="left">No</td><td align="left">start entry id of read range.</td></tr><tr><td align="left">end_entry_id</td><td align="left">Long</td><td align="left">No</td><td align="left">end entry id of read range.</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;entryId1&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;entry content 1&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;entryId2&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;entry content 2&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ...</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h2 class="anchor anchorWithStickyNavbar_LWe7" id="bookie">Bookie<a href="#bookie" class="hash-link" aria-label="Direct link to Bookie" title="Direct link to Bookie"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookieinfo">Endpoint: /api/v1/bookie/info<a href="#endpoint-apiv1bookieinfo" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/info" title="Direct link to Endpoint: /api/v1/bookie/info"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get bookie info</p></li><li><p>Response:</p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">501</td><td align="left">Not implemented</td></tr></tbody></table></li><li><p>Body:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;freeSpace&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;totalSpace&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookielist_bookiestypetypeprint_hostnameshostnames">Endpoint: /api/v1/bookie/list_bookies/?type=<!-- -->&lt;<!-- -->type<!-- -->&gt;<!-- -->&amp;print_hostnames=<!-- -->&lt;<!-- -->hostnames<!-- -->&gt;<a href="#endpoint-apiv1bookielist_bookiestypetypeprint_hostnameshostnames" class="hash-link" aria-label="Direct link to endpoint-apiv1bookielist_bookiestypetypeprint_hostnameshostnames" title="Direct link to endpoint-apiv1bookielist_bookiestypetypeprint_hostnameshostnames"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get all the available bookies.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">type</td><td align="left">String</td><td align="left">Yes</td><td align="left">value: &quot;rw&quot; or &quot;ro&quot; , list read-write/read-only bookies.</td></tr><tr><td align="left">print_hostnames</td><td align="left">Boolean</td><td align="left">No</td><td align="left">whether print hostname of bookies.</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookieSocketAddress1&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;hostname1&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookieSocketAddress2&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;hostname2&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ...</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookielist_bookie_info">Endpoint: /api/v1/bookie/list_bookie_info<a href="#endpoint-apiv1bookielist_bookie_info" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/list_bookie_info" title="Direct link to Endpoint: /api/v1/bookie/list_bookie_info"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get bookies disk usage info of this cluster.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookieAddress&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">free</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> total</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> xxx</span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookieAddress&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">free</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> total</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> xxx</span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ...</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;clusterInfo&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain">total_free</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> xxx</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> total</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> xxx</span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookielast_log_mark">Endpoint: /api/v1/bookie/last_log_mark<a href="#endpoint-apiv1bookielast_log_mark" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/last_log_mark" title="Direct link to Endpoint: /api/v1/bookie/last_log_mark"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get the last log marker.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  JournalId1 </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> position1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  JournalId2 </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> position2</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ...</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookielist_disk_filefile_typetype">Endpoint: /api/v1/bookie/list_disk_file/?file_type=<!-- -->&lt;<!-- -->type<!-- -->&gt;<a href="#endpoint-apiv1bookielist_disk_filefile_typetype" class="hash-link" aria-label="Direct link to endpoint-apiv1bookielist_disk_filefile_typetype" title="Direct link to endpoint-apiv1bookielist_disk_filefile_typetype"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get all the files on disk of current bookie.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">type</td><td align="left">String</td><td align="left">No</td><td align="left">file type: journal/entrylog/index.</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;journal files&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;filename1 filename2 ...&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;entrylog files&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;filename1 filename2...&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;index files&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;filename1 filename2 ...&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookieexpand_storage">Endpoint: /api/v1/bookie/expand_storage<a href="#endpoint-apiv1bookieexpand_storage" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/expand_storage" title="Direct link to Endpoint: /api/v1/bookie/expand_storage"></a></h3><ol><li><p>Method: PUT</p><ul><li><p>Description:  Expand storage for a bookie.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookiegc">Endpoint: /api/v1/bookie/gc<a href="#endpoint-apiv1bookiegc" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/gc" title="Direct link to Endpoint: /api/v1/bookie/gc"></a></h3><ol><li><p>Method: PUT</p><ul><li><p>Description:  trigger gc for this bookie.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li><li><p>Method: GET</p><ul><li><p>Description:  whether force triggered Garbage Collection is running or not for this bookie. true for is running.</p></li><li><p>Response:</p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Body:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;is_in_force_gc&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;false&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookiegc_details">Endpoint: /api/v1/bookie/gc_details<a href="#endpoint-apiv1bookiegc_details" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/gc_details" title="Direct link to Endpoint: /api/v1/bookie/gc_details"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  get details of Garbage Collection Thread, like whether it is in compacting, last compaction time, compaction counter, etc.</p></li><li><p>Response:</p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Body:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;forceCompacting&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">false</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;majorCompacting&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">false</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;minorCompacting&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">false</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;lastMajorCompactionTime&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1544578144944</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;lastMinorCompactionTime&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1544578144944</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;majorCompactionCounter&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;minorCompactionCounter&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">]</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookiestate">Endpoint: /api/v1/bookie/state<a href="#endpoint-apiv1bookiestate" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/state" title="Direct link to Endpoint: /api/v1/bookie/state"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Exposes the current state of bookie</p></li><li><p>Response:</p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Body:</p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;running&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;readOnly&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">false</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;shuttingDown&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">false</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">   </span><span class="token property" style="color:#36acaa">&quot;availableForHighPriorityWrites&quot;</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token boolean" style="color:#36acaa">true</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1bookieis_ready">Endpoint: /api/v1/bookie/is_ready<a href="#endpoint-apiv1bookieis_ready" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/bookie/is_ready" title="Direct link to Endpoint: /api/v1/bookie/is_ready"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Return true if the bookie is ready</p></li><li><p>Response:</p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr><tr><td align="left">503</td><td align="left">Bookie is not ready</td></tr></tbody></table></li><li><p>Body: <!-- -->&lt;<!-- -->empty<!-- -->&gt;</p></li></ul></li></ol><h2 class="anchor anchorWithStickyNavbar_LWe7" id="auto-recovery">Auto recovery<a href="#auto-recovery" class="hash-link" aria-label="Direct link to Auto recovery" title="Direct link to Auto recovery"></a></h2><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1autorecoverybookie">Endpoint: /api/v1/autorecovery/bookie/<a href="#endpoint-apiv1autorecoverybookie" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/autorecovery/bookie/" title="Direct link to Endpoint: /api/v1/autorecovery/bookie/"></a></h3><ol><li>Method: PUT<ul><li><p>Description:  Ledger data recovery for failed bookie</p></li><li><p>Body: </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookie_src&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;bookie_src1&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;bookie_src2&quot;</span><span class="token plain">... </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookie_dest&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;bookie_dest1&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;bookie_dest2&quot;</span><span class="token plain">... </span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;delete_cookie&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> &lt;bool_value&gt;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li><li><p>Parameters:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">bookie_src</td><td align="left">Strings</td><td align="left">Yes</td><td align="left">bookie source to recovery</td></tr><tr><td align="left">bookie_dest</td><td align="left">Strings</td><td align="left">No</td><td align="left">bookie data recovery destination</td></tr><tr><td align="left">delete_cookie</td><td align="left">Boolean</td><td align="left">No</td><td align="left">Whether delete cookie</td></tr></tbody></table></li><li><p>Response: </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1autorecoverylist_under_replicated_ledgermissingreplicabookie_addressexcludingmissingreplicabookie_address">Endpoint: /api/v1/autorecovery/list_under_replicated_ledger/?missingreplica=<!-- -->&lt;<!-- -->bookie_address<!-- -->&gt;<!-- -->&amp;excludingmissingreplica=<!-- -->&lt;<!-- -->bookie_address<!-- -->&gt;<a href="#endpoint-apiv1autorecoverylist_under_replicated_ledgermissingreplicabookie_addressexcludingmissingreplicabookie_address" class="hash-link" aria-label="Direct link to endpoint-apiv1autorecoverylist_under_replicated_ledgermissingreplicabookie_addressexcludingmissingreplicabookie_address" title="Direct link to endpoint-apiv1autorecoverylist_under_replicated_ledgermissingreplicabookie_addressexcludingmissingreplicabookie_address"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get all under replicated ledgers.</p></li><li><p>Parameters: </p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">missingreplica</td><td align="left">String</td><td align="left">No</td><td align="left">missing replica bookieId</td></tr><tr><td align="left">excludingmissingreplica</td><td align="left">String</td><td align="left">No</td><td align="left">exclude missing replica bookieId</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token punctuation" style="color:#393A34">[</span><span class="token plain">ledgerId1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> ledgerId2...</span><span class="token punctuation" style="color:#393A34">]</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1autorecoverywho_is_auditor">Endpoint: /api/v1/autorecovery/who_is_auditor<a href="#endpoint-apiv1autorecoverywho_is_auditor" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/autorecovery/who_is_auditor" title="Direct link to Endpoint: /api/v1/autorecovery/who_is_auditor"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description:  Get auditor bookie id.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li><li><p>Response Body format:  </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;Auditor&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;hostname/hostAddress:Port&quot;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1autorecoverytrigger_audit">Endpoint: /api/v1/autorecovery/trigger_audit<a href="#endpoint-apiv1autorecoverytrigger_audit" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/autorecovery/trigger_audit" title="Direct link to Endpoint: /api/v1/autorecovery/trigger_audit"></a></h3><ol><li><p>Method: PUT</p><ul><li><p>Description: Force trigger audit by resting the lostBookieRecoveryDelay.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1autorecoverylost_bookie_recovery_delay">Endpoint: /api/v1/autorecovery/lost_bookie_recovery_delay<a href="#endpoint-apiv1autorecoverylost_bookie_recovery_delay" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/autorecovery/lost_bookie_recovery_delay" title="Direct link to Endpoint: /api/v1/autorecovery/lost_bookie_recovery_delay"></a></h3><ol><li><p>Method: GET</p><ul><li><p>Description: Get lostBookieRecoveryDelay value in seconds.</p></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li><li><p>Method: PUT</p><ul><li><p>Description: Set lostBookieRecoveryDelay value in seconds.</p></li><li><p>Body: </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;delay_seconds&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> &lt;delay_seconds&gt;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li><li><p>Parameters:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">delay_seconds</td><td align="left">Long</td><td align="left">Yes</td><td align="left">set delay value in seconds.</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol><h3 class="anchor anchorWithStickyNavbar_LWe7" id="endpoint-apiv1autorecoverydecommission">Endpoint: /api/v1/autorecovery/decommission<a href="#endpoint-apiv1autorecoverydecommission" class="hash-link" aria-label="Direct link to Endpoint: /api/v1/autorecovery/decommission" title="Direct link to Endpoint: /api/v1/autorecovery/decommission"></a></h3><ol><li><p>Method: PUT</p><ul><li><p>Description: Decommission Bookie, Force trigger Audit task and make sure all the ledgers stored in the decommissioning bookie are replicated.</p></li><li><p>Body: </p><div class="language-json codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-json codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  </span><span class="token property" style="color:#36acaa">&quot;bookie_src&quot;</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> &lt;bookie_src&gt;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></li><li><p>Parameters:</p><table><thead><tr><th align="left">Name</th><th align="left">Type</th><th align="left">Required</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">bookie_src</td><td align="left">String</td><td align="left">Yes</td><td align="left">Bookie src to decommission..</td></tr></tbody></table></li><li><p>Response:  </p><table><thead><tr><th align="left">Code</th><th align="left">Description</th></tr></thead><tbody><tr><td align="left">200</td><td align="left">Successful operation</td></tr><tr><td align="left">403</td><td align="left">Permission denied</td></tr><tr><td align="left">404</td><td align="left">Not found</td></tr></tbody></table></li></ul></li></ol></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/4.11.1/admin/upgrade"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Upgrade</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/4.11.1/admin/decomission"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Decommission Bookies</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#all-the-endpoints" class="table-of-contents__link toc-highlight">All the endpoints</a></li><li><a href="#heartbeat" class="table-of-contents__link toc-highlight">Heartbeat</a><ul><li><a href="#endpoint-heartbeat" class="table-of-contents__link toc-highlight">Endpoint: /heartbeat</a></li></ul></li><li><a href="#config" class="table-of-contents__link toc-highlight">Config</a><ul><li><a href="#endpoint-apiv1configserver_config" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/config/server_config</a></li></ul></li><li><a href="#metrics" class="table-of-contents__link toc-highlight">Metrics</a><ul><li><a href="#endpoint-metrics" class="table-of-contents__link toc-highlight">Endpoint: /metrics</a></li></ul></li><li><a href="#ledger" class="table-of-contents__link toc-highlight">Ledger</a><ul><li><a href="#endpoint-apiv1ledgerdeleteledger_idledger_id" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/ledger/delete/?ledger_id=&lt;ledger_id&gt;</a></li><li><a href="#endpoint-apiv1ledgerlistprint_metadatametadata" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/ledger/list/?print_metadata=&lt;metadata&gt;</a></li><li><a href="#endpoint-apiv1ledgermetadataledger_idledger_id" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/ledger/metadata/?ledger_id=&lt;ledger_id&gt;</a></li><li><a href="#endpoint-apiv1ledgerreadledger_idledger_idstart_entry_idstart_entry_idend_entry_idend_entry_id" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/ledger/read/?ledger_id=&lt;ledger_id&gt;&amp;start_entry_id=&lt;start_entry_id&gt;&amp;end_entry_id=&lt;end_entry_id&gt;</a></li></ul></li><li><a href="#bookie" class="table-of-contents__link toc-highlight">Bookie</a><ul><li><a href="#endpoint-apiv1bookieinfo" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/info</a></li><li><a href="#endpoint-apiv1bookielist_bookiestypetypeprint_hostnameshostnames" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/list_bookies/?type=&lt;type&gt;&amp;print_hostnames=&lt;hostnames&gt;</a></li><li><a href="#endpoint-apiv1bookielist_bookie_info" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/list_bookie_info</a></li><li><a href="#endpoint-apiv1bookielast_log_mark" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/last_log_mark</a></li><li><a href="#endpoint-apiv1bookielist_disk_filefile_typetype" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/list_disk_file/?file_type=&lt;type&gt;</a></li><li><a href="#endpoint-apiv1bookieexpand_storage" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/expand_storage</a></li><li><a href="#endpoint-apiv1bookiegc" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/gc</a></li><li><a href="#endpoint-apiv1bookiegc_details" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/gc_details</a></li><li><a href="#endpoint-apiv1bookiestate" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/state</a></li><li><a href="#endpoint-apiv1bookieis_ready" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/bookie/is_ready</a></li></ul></li><li><a href="#auto-recovery" class="table-of-contents__link toc-highlight">Auto recovery</a><ul><li><a href="#endpoint-apiv1autorecoverybookie" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/autorecovery/bookie/</a></li><li><a href="#endpoint-apiv1autorecoverylist_under_replicated_ledgermissingreplicabookie_addressexcludingmissingreplicabookie_address" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/autorecovery/list_under_replicated_ledger/?missingreplica=&lt;bookie_address&gt;&amp;excludingmissingreplica=&lt;bookie_address&gt;</a></li><li><a href="#endpoint-apiv1autorecoverywho_is_auditor" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/autorecovery/who_is_auditor</a></li><li><a href="#endpoint-apiv1autorecoverytrigger_audit" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/autorecovery/trigger_audit</a></li><li><a href="#endpoint-apiv1autorecoverylost_bookie_recovery_delay" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/autorecovery/lost_bookie_recovery_delay</a></li><li><a href="#endpoint-apiv1autorecoverydecommission" class="table-of-contents__link toc-highlight">Endpoint: /api/v1/autorecovery/decommission</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Documentation</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/overview">Overview</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/getting-started/installation">Getting started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/deployment/manual">Deployment</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/admin/bookies">Administration</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/api/overview">API</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/security/overview">Security</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/development/protocol">Development</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/reference/config">Reference</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/community/mailing-lists">Mailing lists</a></li><li class="footer__item"><a class="footer__link-item" href="/community/slack">Slack</a></li><li class="footer__item"><a href="https://github.com/apache/bookkeeper" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/asfbookkeeper" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Project</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/project/who">Who are we?</a></li><li class="footer__item"><a class="footer__link-item" href="/project/bylaws">Bylaws</a></li><li class="footer__item"><a href="https://apache.org/licenses" target="_blank" rel="noopener noreferrer" class="footer__link-item">License<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/project/privacy">Privacy policy</a></li><li class="footer__item"><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Sponsorship<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Thanks<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright"><footer class="footer">
         <div class="container">
           <div class="content has-text-centered">
             <p>
               Copyright &copy; 2016 - 2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>,<br> licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, version 2.0</a>.
             </p>
             <p>
               Apache BookKeeper, BookKeeper®, Apache®, the Apache feature logo, and the Apache BookKeeper logo are either registered trademarks or trademarks of The Apache Software Foundation.
             </p>
           </div>
         </div>
       </footer>
       </div></div></div></footer></div>
 <script src="/assets/js/runtime~main.99a29ea0.js"></script>
 <script src="/assets/js/main.812b2dbb.js"></script>
 </body>
 </html>