Files
komodo/api/server.html
T

27 lines
95 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-api/server">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.0">
<title data-rh="true">server | monitor</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:image" content="https://mbecker20.github.io/monitor/img/monitor-lizard.png"><meta data-rh="true" name="twitter:image" content="https://mbecker20.github.io/monitor/img/monitor-lizard.png"><meta data-rh="true" property="og:url" content="https://mbecker20.github.io/monitor/api/server"><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="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="server | monitor"><meta data-rh="true" name="description" content="these routes relate to interacting with monitor servers"><meta data-rh="true" property="og:description" content="these routes relate to interacting with monitor servers"><link data-rh="true" rel="icon" href="/monitor/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://mbecker20.github.io/monitor/api/server"><link data-rh="true" rel="alternate" href="https://mbecker20.github.io/monitor/api/server" hreflang="en"><link data-rh="true" rel="alternate" href="https://mbecker20.github.io/monitor/api/server" hreflang="x-default"><link rel="stylesheet" href="/monitor/assets/css/styles.4aec0824.css">
<link rel="preload" href="/monitor/assets/js/runtime~main.925eed9b.js" as="script">
<link rel="preload" href="/monitor/assets/js/main.15afa6b1.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="/monitor/"><div class="navbar__logo"><img src="/monitor/img/monitor-lizard.png" alt="monitor lizard" class="themedImage_ToTc themedImage--light_HNdA"><img src="/monitor/img/monitor-lizard.png" alt="monitor lizard" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">monitor</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/monitor/intro">docs</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/mbecker20/monitor" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">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><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="/monitor/intro">what is monitor?</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/monitor/core-setup">core setup</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" aria-expanded="false" href="/monitor/connecting-servers">connecting servers</a><button aria-label="Toggle the collapsible sidebar category &#x27;connecting servers&#x27;" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/monitor/build-images">build images</a><button aria-label="Toggle the collapsible sidebar category &#x27;build images&#x27;" type="button" class="clean-btn menu__caret"></button></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" aria-expanded="false" href="/monitor/deploy-containers">deploy containers</a><button aria-label="Toggle the collapsible sidebar category &#x27;deploy containers&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/monitor/permissioning">permissioning resources</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/monitor/file-paths">file paths</a></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--active" aria-expanded="true" href="/monitor/api">API</a><button aria-label="Toggle the collapsible sidebar category &#x27;API&#x27;" type="button" class="clean-btn menu__caret"></button></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="/monitor/api/types">types</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="/monitor/api/authenticating-requests">authenticating requests</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="/monitor/api/login">login</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="/monitor/api/api-secrets">api secrets</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="/monitor/api/build">build</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="/monitor/api/deployment">deployment</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="/monitor/api/server">server</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="/monitor/api/permissions">permissions</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="/monitor/api/websocket">websocket</a></li></ul></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><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/monitor/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/monitor/api"><span itemprop="name">API</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">server</span><meta itemprop="position" content="2"></li></ul></nav><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"><h1>server</h1><p>these routes relate to interacting with monitor <code>servers</code></p><table><thead><tr><th>name</th><th>route</th></tr></thead><tbody><tr><td><a href="/monitor/api/server#list-servers">list servers</a></td><td><code>GET /api/server/list</code></td></tr><tr><td><a href="/monitor/api/server#get-server">get server</a></td><td><code>GET /api/server/&lt;server_id&gt;</code></td></tr><tr><td><a href="/monitor/api/server#get-server-action-state">get server action state</a></td><td><code>GET /api/server/&lt;server_id&gt;/action_state</code></td></tr><tr><td><a href="/monitor/api/server#get-server-github-accounts">get server github accounts</a></td><td><code>GET /api/server/&lt;server_id&gt;/github_accounts</code></td></tr><tr><td><a href="/monitor/api/server#get-server-docker-accounts">get server docker accounts</a></td><td><code>GET /api/server/&lt;server_id&gt;/docker_accounts</code></td></tr><tr><td><a href="/monitor/api/server#get-server-available-secrets">get server available secrets</a></td><td><code>GET /api/server/&lt;server_id&gt;/secrets</code></td></tr><tr><td><a href="/monitor/api/server#create-server">create server</a></td><td><code>POST /api/server/create</code></td></tr><tr><td><a href="/monitor/api/server#create-full-server">create full server</a></td><td><code>POST /api/server/create_full</code></td></tr><tr><td><a href="/monitor/api/server#delete-server">delete server</a></td><td><code>DELETE /api/server/&lt;server_id&gt;/delete</code></td></tr><tr><td><a href="/monitor/api/server#update-server">update server</a></td><td><code>PATCH /api/server/update</code></td></tr><tr><td><a href="/monitor/api/server#get-server-periphery-version">get server periphery version</a></td><td><code>GET /api/server/&lt;server_id&gt;/version</code></td></tr><tr><td><a href="/monitor/api/server#get-server-system-information">get server system information</a></td><td><code>GET /api/server/&lt;server_id&gt;/system_information</code></td></tr><tr><td><a href="/monitor/api/server#get-server-stats">get server stats</a></td><td><code>GET /api/server/&lt;server_id&gt;/stats</code></td></tr><tr><td><a href="/monitor/api/server#get-server-stats-history">get server stats history</a></td><td><code>GET /api/server/&lt;server_id&gt;/stats/history</code></td></tr><tr><td><a href="/monitor/api/server#get-server-stats-at-time">get server stats at time</a></td><td><code>GET /api/server/&lt;server_id&gt;/stats/at_ts</code></td></tr><tr><td><a href="/monitor/api/server#get-docker-networks">get docker networks</a></td><td><code>GET /api/server/&lt;server_id&gt;/networks</code></td></tr><tr><td><a href="/monitor/api/server#prune-docker-networks">prune docker networks</a></td><td><code>POST /api/server/&lt;server_id&gt;/networks/prune</code></td></tr><tr><td><a href="/monitor/api/server#get-docker-images">get docker images</a></td><td><code>GET /api/server/&lt;server_id&gt;/images</code></td></tr><tr><td><a href="/monitor/api/server#prune-docker-images">prune docker images</a></td><td><code>POST /api/server/&lt;server_id&gt;/images/prune</code></td></tr><tr><td><a href="/monitor/api/server#get-docker-containers">get docker containers</a></td><td><code>GET /api/server/&lt;server_id&gt;/containers</code></td></tr><tr><td><a href="/monitor/api/server#prune-docker-containers">prune docker containers</a></td><td><code>POST /api/server/&lt;server_id&gt;/containers/prune</code></td></tr></tbody></table><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="list-servers">list servers<a href="#list-servers" class="hash-link" aria-label="Direct link to list servers" title="Direct link to list servers">​</a></h2><p><code>GET /api/server/list</code></p><p>this method will return an array of servers with their status
that the requesting user has a minimum of <code>Read</code> permissions on.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body">response body<a href="#response-body" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> server</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Server</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"> status</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> ServerStatus</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 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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server">get server<a href="#get-server" class="hash-link" aria-label="Direct link to get server" title="Direct link to get server">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;</code></p><p>this method will return the server with server status that
the requesting user has a minimum of <code>Read</code> permissions on.
it will return <code>500: Internal Server Error</code> if the user does not have the required permissions.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-1">response body<a href="#response-body-1" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"> server</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Server</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"> status</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> ServerStatus</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-action-state">get server action state<a href="#get-server-action-state" class="hash-link" aria-label="Direct link to get server action state" title="Direct link to get server action state">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/action_state</code></p><p>this method returns the action state for the server, eg. whether the server is currently <code>pruning_images</code>.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-2">response body<a href="#response-body-2" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"> pruning_networks</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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"> pruning_containers</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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"> pruning_images</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-github-accounts">get server github accounts<a href="#get-server-github-accounts" class="hash-link" aria-label="Direct link to get server github accounts" title="Direct link to get server github accounts">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/github_accounts</code></p><p>this method returns a list of all the github account usernames that are available on the server,
as defined in the server&#x27;s periphery config under <!-- -->[github_accounts]<!-- -->.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-3">response body<a href="#response-body-3" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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 string" style="color:#e3116c">&quot;&lt;github_username_1&gt;&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;&lt;github_username_2&gt;&quot;</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-docker-accounts">get server docker accounts<a href="#get-server-docker-accounts" class="hash-link" aria-label="Direct link to get server docker accounts" title="Direct link to get server docker accounts">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/docker_accounts</code></p><p>this method returns a list of all the docker account usernames that are available on the server,
as defined in the server&#x27;s periphery config under <!-- -->[docker_accounts]<!-- -->.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-4">response body<a href="#response-body-4" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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 string" style="color:#e3116c">&quot;&lt;docker_username_1&gt;&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;&lt;docker_username_2&gt;&quot;</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-available-secrets">get server available secrets<a href="#get-server-available-secrets" class="hash-link" aria-label="Direct link to get server available secrets" title="Direct link to get server available secrets">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/secrets</code></p><p>this method returns a list of all the secret keys that are available on the server,
as defined in the server&#x27;s periphery config under <!-- -->[secrets]<!-- -->.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-5">response body<a href="#response-body-5" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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 string" style="color:#e3116c">&quot;&lt;secret_key_1&gt;&quot;</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">&quot;&lt;secret_key_2&gt;&quot;</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="create-server">create server<a href="#create-server" class="hash-link" aria-label="Direct link to create server" title="Direct link to create server">​</a></h2><p><code>POST /api/server/create</code></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="request-body">request body<a href="#request-body" class="hash-link" aria-label="Direct link to request body" title="Direct link to request body">​</a></h3><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"> name</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> address</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// eg. http://12.34.56.78:8000</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><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><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-6">response body<a href="#response-body-6" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#server">Server</a></p><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="create-full-server">create full server<a href="#create-full-server" class="hash-link" aria-label="Direct link to create full server" title="Direct link to create full server">​</a></h2><p><code>POST /api/server/create_full</code></p><p>this method is used to create a new server, already initialized with config.
it will return the created server.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="request-body-1">request body<a href="#request-body-1" class="hash-link" aria-label="Direct link to request body" title="Direct link to request body">​</a></h3><p><a href="/monitor/api/types#server">Server</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-7">response body<a href="#response-body-7" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#server">Server</a></p><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="delete-server">delete server<a href="#delete-server" class="hash-link" aria-label="Direct link to delete server" title="Direct link to delete server">​</a></h2><p><code>DELETE /api/server/&lt;server_id&gt;/delete</code></p><p>this method will delete the server, along with all deployments attached to the server.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-8">response body<a href="#response-body-8" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#server">Server</a></p><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="update-server">update server<a href="#update-server" class="hash-link" aria-label="Direct link to update server" title="Direct link to update server">​</a></h2><p><code>PATCH /api/server/update</code></p><p>this method is used to update a servers configuration.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="request-body-2">request body<a href="#request-body-2" class="hash-link" aria-label="Direct link to request body" title="Direct link to request body">​</a></h3><p><a href="/monitor/api/types#server">Server</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-9">response body<a href="#response-body-9" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#server">Server</a></p><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-periphery-version">get server periphery version<a href="#get-server-periphery-version" class="hash-link" aria-label="Direct link to get server periphery version" title="Direct link to get server periphery version">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/version</code></p><p>this method is used to get the version of the periphery binary running on the server.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-10">response body<a href="#response-body-10" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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 plain">string </span><span class="token comment" style="color:#999988;font-style:italic">// the periphery version</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-system-information">get server system information<a href="#get-server-system-information" class="hash-link" aria-label="Direct link to get server system information" title="Direct link to get server system information">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/system_information</code></p><p>this method gets some information about the host system running the periphery binary.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-11">response body<a href="#response-body-11" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"> name?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// the name of the system</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> os?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// the os the system is running</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> kernel?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// the version of the kernel</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> core_count?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// number of cores in the cpu</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> host_name?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// host name of the system</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> cpu_brand</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// information on the cpu of the system</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-stats">get server stats<a href="#get-server-stats" class="hash-link" aria-label="Direct link to get server stats" title="Direct link to get server stats">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/stats</code></p><p>this method retrieves current system stats of the server.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="query-params">query params<a href="#query-params" class="hash-link" aria-label="Direct link to query params" title="Direct link to query params">​</a></h3><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 plain">cpus=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include information about each core individually</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">disks=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include breakdown of disk usage by mount point</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">networks=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include info on network usage</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">components=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include component tempurature</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">processes=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include all system processes running on host and their resource usage</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><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-12">response body<a href="#response-body-12" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"> system_load</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> cpu_perc</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> cpu_freq_mhz</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> mem_used_gb</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> mem_total_gb</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> disk</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 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"> cpus</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 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"> networks</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 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"> components</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 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"> processes</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 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"> polling_rate</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Timelength</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"> refresh_ts</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> refresh_list_ts</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-stats-history">get server stats history<a href="#get-server-stats-history" class="hash-link" aria-label="Direct link to get server stats history" title="Direct link to get server stats history">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/stats/history</code></p><p>this method will return historical system stats for the server.
the response is paginated, to get older data, specify a higher page number.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="query-params-1">query params<a href="#query-params-1" class="hash-link" aria-label="Direct link to query params" title="Direct link to query params">​</a></h3><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 plain">interval=Timelength </span><span class="token comment" style="color:#999988;font-style:italic">// optional, default interval is 1-hr. controls granularity of historical data</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">limit=number </span><span class="token comment" style="color:#999988;font-style:italic">// optional, default is 100, max is 500. specifies the number of data points to fetch</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">page=number </span><span class="token comment" style="color:#999988;font-style:italic">// optional, default is 0. specifies the page of data, going backward in time.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">networks=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include historical info on network usage</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">components=boolean </span><span class="token comment" style="color:#999988;font-style:italic">// optional. if true, response will include historical component tempuratures</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><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-13">response body<a href="#response-body-13" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> ts</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// unix timestamp in ms</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> server_id</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string </span><span class="token comment" style="color:#999988;font-style:italic">// specifies the server</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> system_load</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> cpu_perc</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> cpu_freq_mhz</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> mem_used_gb</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> mem_total_gb</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> disk</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 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"> cpus</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 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"> networks</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 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"> components</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 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"> processes</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 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"> polling_rate</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Timelength</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><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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-server-stats-at-time">get server stats at time<a href="#get-server-stats-at-time" class="hash-link" aria-label="Direct link to get server stats at time" title="Direct link to get server stats at time">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/stats/at_ts</code></p><p>this method retrieves the historical stats for a server at a specific timestamp</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="query-params-2">query params<a href="#query-params-2" class="hash-link" aria-label="Direct link to query params" title="Direct link to query params">​</a></h3><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 plain">ts=number </span><span class="token comment" style="color:#999988;font-style:italic">// required. the timestamp in ms</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><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-14">response body<a href="#response-body-14" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"> ts</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// unix timestamp in ms</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> server_id</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string </span><span class="token comment" style="color:#999988;font-style:italic">// specifies the server</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> system_load</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> cpu_perc</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> cpu_freq_mhz</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> mem_used_gb</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> mem_total_gb</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> disk</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 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"> cpus</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 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"> networks</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 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"> components</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 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"> processes</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 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"> polling_rate</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Timelength</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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-docker-networks">get docker networks<a href="#get-docker-networks" class="hash-link" aria-label="Direct link to get docker networks" title="Direct link to get docker networks">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/networks</code></p><p>this method retrieves the docker networks on the server</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-15">response body<a href="#response-body-15" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> Name?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> Id?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> Created?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> Scope?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> Driver?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> EnableIPv6?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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"> IPAM?</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><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> Driver?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> Config?</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><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><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> Subnet?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> IPRange?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> Gateway?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> AuxiliaryAddresses?</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 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 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><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"> Options?</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 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 punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> Internal?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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"> Attachable?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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"> Ingress?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> boolean</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"> Containers?</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 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"> Options?</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 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"> Labels?</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 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 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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="prune-docker-networks">prune docker networks<a href="#prune-docker-networks" class="hash-link" aria-label="Direct link to prune docker networks" title="Direct link to prune docker networks">​</a></h2><p><code>POST /api/server/&lt;server_id&gt;/networks/prune</code></p><p>this method triggers the <code>network prune</code> action on the server, which runs
<code>docker network prune -f</code> on the target server</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-16">response body<a href="#response-body-16" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#update">Update</a></p><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-docker-images">get docker images<a href="#get-docker-images" class="hash-link" aria-label="Direct link to get docker images" title="Direct link to get docker images">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/images</code></p><p>this method will return a list of images available locally on the server</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-17">response body<a href="#response-body-17" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> Id</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> ParentId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> RepoTags</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">string</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"> RepoDigests</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">string</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"> Created</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> Size</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> SharedSize</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> VirtualSize</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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"> Labels</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 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"> Containers</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number</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><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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="prune-docker-images">prune docker images<a href="#prune-docker-images" class="hash-link" aria-label="Direct link to prune docker images" title="Direct link to prune docker images">​</a></h2><p><code>POST /api/server/&lt;server_id&gt;/images/prune</code></p><p>this method triggers the <code>image prune</code> action, which runs
<code>docker image prune -a -f</code> on the target server</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-18">response body<a href="#response-body-18" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#update">Update</a></p><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="get-docker-containers">get docker containers<a href="#get-docker-containers" class="hash-link" aria-label="Direct link to get docker containers" title="Direct link to get docker containers">​</a></h2><p><code>GET /api/server/&lt;server_id&gt;/containers</code></p><p>this method is used to retrieve information about all the containers on the target server</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-19">response body<a href="#response-body-19" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><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"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> name</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> id</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> image</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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"> state</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> DockerContainerState</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"> status?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> string</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><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><div style="opacity:0.7;background-color:rgb(175, 175, 175);height:3px;width:100%;margin:75px 0px"></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="prune-docker-containers">prune docker containers<a href="#prune-docker-containers" class="hash-link" aria-label="Direct link to prune docker containers" title="Direct link to prune docker containers">​</a></h2><p><code>POST /api/server/&lt;server_id&gt;/containers/prune</code></p><p>this method triggers the <code>container prune</code> action, which runs
<code>docker container prune -f</code> on the target server</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="response-body-20">response body<a href="#response-body-20" class="hash-link" aria-label="Direct link to response body" title="Direct link to response body">​</a></h3><p><a href="/monitor/api/types#update">Update</a></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/mbecker20/monitor/tree/main/docsite/docs/api/server.mdx" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/monitor/api/deployment"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">deployment</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/monitor/api/permissions"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">permissions</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="#list-servers" class="table-of-contents__link toc-highlight">list servers</a><ul><li><a href="#response-body" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server" class="table-of-contents__link toc-highlight">get server</a><ul><li><a href="#response-body-1" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-action-state" class="table-of-contents__link toc-highlight">get server action state</a><ul><li><a href="#response-body-2" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-github-accounts" class="table-of-contents__link toc-highlight">get server github accounts</a><ul><li><a href="#response-body-3" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-docker-accounts" class="table-of-contents__link toc-highlight">get server docker accounts</a><ul><li><a href="#response-body-4" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-available-secrets" class="table-of-contents__link toc-highlight">get server available secrets</a><ul><li><a href="#response-body-5" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#create-server" class="table-of-contents__link toc-highlight">create server</a><ul><li><a href="#request-body" class="table-of-contents__link toc-highlight">request body</a></li><li><a href="#response-body-6" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#create-full-server" class="table-of-contents__link toc-highlight">create full server</a><ul><li><a href="#request-body-1" class="table-of-contents__link toc-highlight">request body</a></li><li><a href="#response-body-7" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#delete-server" class="table-of-contents__link toc-highlight">delete server</a><ul><li><a href="#response-body-8" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#update-server" class="table-of-contents__link toc-highlight">update server</a><ul><li><a href="#request-body-2" class="table-of-contents__link toc-highlight">request body</a></li><li><a href="#response-body-9" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-periphery-version" class="table-of-contents__link toc-highlight">get server periphery version</a><ul><li><a href="#response-body-10" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-system-information" class="table-of-contents__link toc-highlight">get server system information</a><ul><li><a href="#response-body-11" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-stats" class="table-of-contents__link toc-highlight">get server stats</a><ul><li><a href="#query-params" class="table-of-contents__link toc-highlight">query params</a></li><li><a href="#response-body-12" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-stats-history" class="table-of-contents__link toc-highlight">get server stats history</a><ul><li><a href="#query-params-1" class="table-of-contents__link toc-highlight">query params</a></li><li><a href="#response-body-13" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-server-stats-at-time" class="table-of-contents__link toc-highlight">get server stats at time</a><ul><li><a href="#query-params-2" class="table-of-contents__link toc-highlight">query params</a></li><li><a href="#response-body-14" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-docker-networks" class="table-of-contents__link toc-highlight">get docker networks</a><ul><li><a href="#response-body-15" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#prune-docker-networks" class="table-of-contents__link toc-highlight">prune docker networks</a><ul><li><a href="#response-body-16" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-docker-images" class="table-of-contents__link toc-highlight">get docker images</a><ul><li><a href="#response-body-17" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#prune-docker-images" class="table-of-contents__link toc-highlight">prune docker images</a><ul><li><a href="#response-body-18" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-docker-containers" class="table-of-contents__link toc-highlight">get docker containers</a><ul><li><a href="#response-body-19" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#prune-docker-containers" class="table-of-contents__link toc-highlight">prune docker containers</a><ul><li><a href="#response-body-20" class="table-of-contents__link toc-highlight">response body</a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class="footer__copyright">Built with Docusaurus</div></div></div></footer></div>
<script src="/monitor/assets/js/runtime~main.925eed9b.js"></script>
<script src="/monitor/assets/js/main.15afa6b1.js"></script>
</body>
</html>