Files
komodo/api/deployment.html
T

31 lines
60 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/deployment">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.0">
<title data-rh="true">deployment | 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/img/monitor-lizard.png"><meta data-rh="true" name="twitter:image" content="https://mbecker20.github.io/img/monitor-lizard.png"><meta data-rh="true" property="og:url" content="https://mbecker20.github.io/api/deployment"><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="deployment | monitor"><meta data-rh="true" name="description" content="these routes relate to interacting with monitor deployments"><meta data-rh="true" property="og:description" content="these routes relate to interacting with monitor deployments"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://mbecker20.github.io/api/deployment"><link data-rh="true" rel="alternate" href="https://mbecker20.github.io/api/deployment" hreflang="en"><link data-rh="true" rel="alternate" href="https://mbecker20.github.io/api/deployment" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.76af9f58.css">
<link rel="preload" href="/assets/js/runtime~main.742c58b2.js" as="script">
<link rel="preload" href="/assets/js/main.65ea3c4d.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/monitor-lizard.png" alt="monitor lizard" class="themedImage_ToTc themedImage--light_HNdA"><img src="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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="/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 menu__link--active" aria-current="page" tabindex="0" href="/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" tabindex="0" href="/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="/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="/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="/"><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="/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">deployment</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>deployment</h1><p>these routes relate to interacting with monitor <code>deployments</code></p><table><thead><tr><th>name</th><th>route</th></tr></thead><tbody><tr><td><a href="/api/deployment#list-deployments">list deployments</a></td><td><code>GET /api/deployment/list</code></td></tr><tr><td><a href="/api/deployment#get-deployment">get deployment</a></td><td><code>GET /api/deployment/&lt;deployment_id&gt;</code></td></tr><tr><td><a href="/api/deployment#get-deployment-action-state">get deployment action state</a></td><td><code>GET /api/deployment/&lt;deployment_id&gt;/action_state</code></td></tr><tr><td><a href="/api/deployment#get-deployment-container-log">get deployment container log</a></td><td><code>GET /api/deployment/&lt;deployment_id&gt;/log</code></td></tr><tr><td><a href="/api/deployment#get-deployment-container-stats">get deployment container stats</a></td><td><code>GET /api/deployment/&lt;deployment_id&gt;/stats</code></td></tr><tr><td><a href="/api/deployment#get-deployment-deployed-version">get deployment deployed version</a></td><td><code>GET /api/deployment/&lt;deployment_id&gt;/deployed_version</code></td></tr><tr><td><a href="/api/deployment#create-deployment">create deployment</a></td><td><code>POST /api/deployment/create</code></td></tr><tr><td><a href="/api/deployment#create-full-deployment">create full deployment</a></td><td><code>POST /api/deployment/create_full</code></td></tr><tr><td><a href="/api/deployment#copy-deployment">copy deployment</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/copy</code></td></tr><tr><td><a href="/api/deployment#delete-deployment">delete deployment</a></td><td><code>DELETE /api/deployment/&lt;deployment_id&gt;/delete</code></td></tr><tr><td><a href="/api/deployment#update-deployment">update deployment</a></td><td><code>PATCH /api/deployment/update</code></td></tr><tr><td><a href="/api/deployment#rename-deployment">rename deployment</a></td><td><code>PATCH /api/deployment/&lt;deployment_id&gt;/rename</code></td></tr><tr><td><a href="/api/deployment#reclone-deployment">reclone deployment</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/reclone</code></td></tr><tr><td><a href="/api/deployment#pull-deployment">pull deployment</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/pull</code></td></tr><tr><td><a href="/api/deployment#deploy-container">deploy container</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/deploy</code></td></tr><tr><td><a href="/api/deployment#start-container">start container</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/start_container</code></td></tr><tr><td><a href="/api/deployment#stop-container">stop container</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/stop_container</code></td></tr><tr><td><a href="/api/deployment#remove-container">remove container</a></td><td><code>POST /api/deployment/&lt;deployment_id&gt;/remove_container</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-deployments">list deployments<a href="#list-deployments" class="hash-link" aria-label="Direct link to list deployments" title="Direct link to list deployments">​</a></h2><p><code>GET /api/deployment/list</code></p><p>this method will return an array of deployments with container state 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"> deployment</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Deployment</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"> container?</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"> 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 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-deployment">get deployment<a href="#get-deployment" class="hash-link" aria-label="Direct link to get deployment" title="Direct link to get deployment">​</a></h2><p><code>GET /api/deployment/&lt;deployment_id&gt;</code></p><p>this method will return the deployment with container state 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"> deployment</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Deployment</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"> container?</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"> 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 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-deployment-action-state">get deployment action state<a href="#get-deployment-action-state" class="hash-link" aria-label="Direct link to get deployment action state" title="Direct link to get deployment action state">​</a></h2><p><code>GET /api/deployment/&lt;deployment_id&gt;/action_state</code></p><p>this method returns the action state for the deployment, eg. whether the deployment is currently <code>deploying</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"> deploying</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"> stopping</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"> starting</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"> removing</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"> pulling</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"> recloning</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"> updating</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"> renaming</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-deployment-container-log">get deployment container log<a href="#get-deployment-container-log" class="hash-link" aria-label="Direct link to get deployment container log" title="Direct link to get deployment container log">​</a></h2><p><code>GET /api/deployment/&lt;deployment_id&gt;/log</code></p><p>this method is used to get the container&#x27;s log associated with the deployment.</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 punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> tail</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> number </span><span class="token comment" style="color:#999988;font-style:italic">// number of log lines to fetch. this is passed to the --tail flag of docker logs command</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><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 plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> stdout</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"> stderr</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><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-deployment-container-stats">get deployment container stats<a href="#get-deployment-container-stats" class="hash-link" aria-label="Direct link to get deployment container stats" title="Direct link to get deployment container stats">​</a></h2><p><code>GET /api/deployment/&lt;deployment_id&gt;/stats</code></p><p>this method returns the results of running <code>docker stats &lt;container_name&gt;</code>
for the container associated with the deployment.</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 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"> cpu_perc</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"> mem_perc</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"> mem_usage</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"> net_io</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"> block_io</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"> pids</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><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-deployment-deployed-version">get deployment deployed version<a href="#get-deployment-deployed-version" class="hash-link" aria-label="Direct link to get deployment deployed version" title="Direct link to get deployment deployed version">​</a></h2><p><code>GET /api/deployment/&lt;deployment_id&gt;/deployed_version</code></p><p>this method is used to get the image version of the container associated with the deployment, if it exists.
otherwise, it will return the version specified in the deployment config.</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 plain">string </span><span class="token comment" style="color:#999988;font-style:italic">// the deployed version like &#x27;0.2.4&#x27;</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-deployment">create deployment<a href="#create-deployment" class="hash-link" aria-label="Direct link to create deployment" title="Direct link to create deployment">​</a></h2><p><code>POST /api/deployment/create</code></p><p>this method is used to create a new deployment on a particular server.
it will return the created deployment.</p><div class="theme-admonition theme-admonition-note alert alert--secondary admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"></path></svg></span>note</div><div class="admonitionContent_S0QG"><p>users must be <strong>admin</strong> or have <code>update</code> permissions on the server specified by the <code>server_id</code>
in the request body in order for this request to succeed.</p></div></div><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"> server_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"></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><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="/api/types#deployment">Deployment</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-deployment">create full deployment<a href="#create-full-deployment" class="hash-link" aria-label="Direct link to create full deployment" title="Direct link to create full deployment">​</a></h2><p><code>POST /api/deployment/create_full</code></p><p>this method is used to create a new deployment on a particular server, already initialized with config.
it will return the created deployment</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="/api/types#deployment">Deployment</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="/api/types#deployment">Deployment</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="copy-deployment">copy deployment<a href="#copy-deployment" class="hash-link" aria-label="Direct link to copy deployment" title="Direct link to copy deployment">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/copy</code></p><p>this method will create a copy of the deployment with a new _id and name,
with all the same configuration as the target deployment.
it can be used to move the deployment to another server.</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><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"> server_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"></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><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="/api/types#deployment">Deployment</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-deployment">delete deployment<a href="#delete-deployment" class="hash-link" aria-label="Direct link to delete deployment" title="Direct link to delete deployment">​</a></h2><p><code>DELETE /api/deployment/&lt;deployment_id&gt;/delete</code></p><p>this method will delete the deployment. if a container is associated with the deployment, it will be destroyed.</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="/api/types#deployment">Deployment</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-deployment">update deployment<a href="#update-deployment" class="hash-link" aria-label="Direct link to update deployment" title="Direct link to update deployment">​</a></h2><p><code>PATCH /api/deployment/update</code></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="request-body-3">request body<a href="#request-body-3" class="hash-link" aria-label="Direct link to request body" title="Direct link to request body">​</a></h3><p><a href="/api/types#deployment">Deployment</a></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><p><a href="/api/types#deployment">Deployment</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="rename-deployment">rename deployment<a href="#rename-deployment" class="hash-link" aria-label="Direct link to rename deployment" title="Direct link to rename deployment">​</a></h2><p><code>PATCH /api/deployment/&lt;deployment_id&gt;/rename</code></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="request-body-4">request body<a href="#request-body-4" 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"> new_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"></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="reclone-deployment">reclone deployment<a href="#reclone-deployment" class="hash-link" aria-label="Direct link to reclone deployment" title="Direct link to reclone deployment">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/reclone</code></p><p>if the deployment has a repo attached, this will reclone the repo,
including the on-clone and on-pull actions.</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><p><a href="/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="pull-deployment">pull deployment<a href="#pull-deployment" class="hash-link" aria-label="Direct link to pull deployment" title="Direct link to pull deployment">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/pull</code></p><p>if the deployment has a repo attached, this will <code>git pull</code> in the repo,
including the on-pull action.</p><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><p><a href="/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="deploy-container">deploy container<a href="#deploy-container" class="hash-link" aria-label="Direct link to deploy container" title="Direct link to deploy container">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/deploy</code></p><p>this will deploy the container corresponding to the deployments configuration.
if the container already exists, it will destroy it first.</p><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><p><a href="/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="start-container">start container<a href="#start-container" class="hash-link" aria-label="Direct link to start container" title="Direct link to start container">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/start_container</code></p><p>this will run <code>docker start &lt;container_name&gt;</code> for the container
corresponding to the deployment</p><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><p><a href="/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="stop-container">stop container<a href="#stop-container" class="hash-link" aria-label="Direct link to stop container" title="Direct link to stop container">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/stop_container</code></p><p>this will run <code>docker stop &lt;container_name&gt;</code> for the container
corresponding to the deployment</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><p><a href="/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="remove-container">remove container<a href="#remove-container" class="hash-link" aria-label="Direct link to remove container" title="Direct link to remove container">​</a></h2><p><code>POST /api/deployment/&lt;deployment_id&gt;/remove_container</code></p><p>this will run <code>docker stop &lt;container_name&gt; &amp;&amp; docker container rm &lt;container_name&gt;</code>
for the container corresponding to the deployment</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="/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/deployment.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="/api/build"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">build</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/api/server"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">server</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-deployments" class="table-of-contents__link toc-highlight">list deployments</a><ul><li><a href="#response-body" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-deployment" class="table-of-contents__link toc-highlight">get deployment</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-deployment-action-state" class="table-of-contents__link toc-highlight">get deployment 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-deployment-container-log" class="table-of-contents__link toc-highlight">get deployment container log</a><ul><li><a href="#query-params" class="table-of-contents__link toc-highlight">query params</a></li><li><a href="#response-body-3" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#get-deployment-container-stats" class="table-of-contents__link toc-highlight">get deployment container stats</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-deployment-deployed-version" class="table-of-contents__link toc-highlight">get deployment deployed version</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-deployment" class="table-of-contents__link toc-highlight">create deployment</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-deployment" class="table-of-contents__link toc-highlight">create full deployment</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="#copy-deployment" class="table-of-contents__link toc-highlight">copy deployment</a><ul><li><a href="#request-body-2" class="table-of-contents__link toc-highlight">request body</a></li><li><a href="#response-body-8" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#delete-deployment" class="table-of-contents__link toc-highlight">delete deployment</a><ul><li><a href="#response-body-9" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#update-deployment" class="table-of-contents__link toc-highlight">update deployment</a><ul><li><a href="#request-body-3" class="table-of-contents__link toc-highlight">request body</a></li><li><a href="#response-body-10" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#rename-deployment" class="table-of-contents__link toc-highlight">rename deployment</a><ul><li><a href="#request-body-4" class="table-of-contents__link toc-highlight">request body</a></li></ul></li><li><a href="#reclone-deployment" class="table-of-contents__link toc-highlight">reclone deployment</a><ul><li><a href="#response-body-11" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#pull-deployment" class="table-of-contents__link toc-highlight">pull deployment</a><ul><li><a href="#response-body-12" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#deploy-container" class="table-of-contents__link toc-highlight">deploy container</a><ul><li><a href="#response-body-13" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#start-container" class="table-of-contents__link toc-highlight">start container</a><ul><li><a href="#response-body-14" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#stop-container" class="table-of-contents__link toc-highlight">stop container</a><ul><li><a href="#response-body-15" class="table-of-contents__link toc-highlight">response body</a></li></ul></li><li><a href="#remove-container" class="table-of-contents__link toc-highlight">remove container</a><ul><li><a href="#response-body-16" 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="/assets/js/runtime~main.742c58b2.js"></script>
<script src="/assets/js/main.65ea3c4d.js"></script>
</body>
</html>