From 8f8adde231cd9dbb345bbc801a453105a1b0d677 Mon Sep 17 00:00:00 2001
From: Vignesh Rao <svignesh1793@gmail.com>
Date: Sun, 5 Jan 2025 18:37:45 -0600
Subject: [PATCH] Dynamically generate the API description for SwaggerUI

---
 doc_gen/index.rst            |   7 ++-
 docs/README.html             |   2 +-
 docs/_sources/index.rst.txt  |   7 ++-
 docs/genindex.html           |  40 ++++++++++++----
 docs/index.html              |  86 +++++++++++++++++++++++++++++++----
 docs/objects.inv             | Bin 2332 -> 2426 bytes
 docs/searchindex.js          |   2 +-
 pyninja/executors/routers.py |   2 +-
 pyninja/main.py              |  83 +++++++++++++++++++--------------
 pyninja/modules/enums.py     |  14 +++++-
 pyninja/modules/models.py    |  18 ++++++++
 11 files changed, 202 insertions(+), 59 deletions(-)
diff --git a/doc_gen/index.rst b/doc_gen/index.rst
index e04e776..405a87a 100644
--- a/doc_gen/index.rst
+++ b/doc_gen/index.rst
@@ -93,6 +93,11 @@ Exceptions
 Models
 ------
 
+.. autoclass:: pyninja.modules.models.RoutingHandler(BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
+====
+
 .. autoclass:: pyninja.modules.models.ServiceStatus(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
@@ -124,7 +129,7 @@ Models
 ====
 
 .. automodule:: pyninja.modules.models
-   :exclude-members: ServiceStatus, Architecture, Session, WSSession, RateLimit, EnvConfig, session, ws_session, env, database, architecture
+   :exclude-members: RoutingHandler, ServiceStatus, Architecture, Session, WSSession, RateLimit, EnvConfig, session, ws_session, env, database, architecture
 
 Payloads
 --------
diff --git a/docs/README.html b/docs/README.html
index b30b427..7910e68 100644
--- a/docs/README.html
+++ b/docs/README.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>PyNinja &#8212; PyNinja  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
index e04e776..405a87a 100644
--- a/docs/_sources/index.rst.txt
+++ b/docs/_sources/index.rst.txt
@@ -93,6 +93,11 @@ Exceptions
 Models
 ------
 
+.. autoclass:: pyninja.modules.models.RoutingHandler(BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
+====
+
 .. autoclass:: pyninja.modules.models.ServiceStatus(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
@@ -124,7 +129,7 @@ Models
 ====
 
 .. automodule:: pyninja.modules.models
-   :exclude-members: ServiceStatus, Architecture, Session, WSSession, RateLimit, EnvConfig, session, ws_session, env, database, architecture
+   :exclude-members: RoutingHandler, ServiceStatus, Architecture, Session, WSSession, RateLimit, EnvConfig, session, ws_session, env, database, architecture
 
 Payloads
 --------
diff --git a/docs/genindex.html b/docs/genindex.html
index 2ed9616..369935e 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -75,10 +75,14 @@ <h2 id="A">A</h2>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints">APIEndpoints (class in pyninja.modules.enums)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.apikey">apikey (pyninja.modules.models.EnvConfig attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.exceptions.APIResponse">APIResponse</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#pyninja.modules.exceptions.APIResponse">APIResponse</a>
+      <li><a href="index.html#pyninja.modules.enums.APIRouteType">APIRouteType (class in pyninja.modules.enums)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.RoutingHandler.Config.arbitrary_types_allowed">arbitrary_types_allowed (pyninja.modules.models.RoutingHandler.Config attribute)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.Architecture">Architecture (class in pyninja.modules.models)</a>
 </li>
@@ -180,16 +184,18 @@ <h2 id="D">D</h2>
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#pyninja.modules.models.RoutingHandler.enabled">enabled (pyninja.modules.models.RoutingHandler attribute)</a>
+</li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig">EnvConfig (class in pyninja.modules.models)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.Config">EnvConfig.Config (class in pyninja.modules.models)</a>
 </li>
       <li><a href="index.html#pyninja.executors.squire.envfile_loader">envfile_loader() (in module pyninja.executors.squire)</a>
-</li>
-      <li><a href="index.html#pyninja.executors.auth.EPOCH">EPOCH() (in module pyninja.executors.auth)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#pyninja.executors.auth.EPOCH">EPOCH() (in module pyninja.executors.auth)</a>
+</li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.error">error (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
       <li><a href="index.html#pyninja.monitor.routes.error_endpoint">error_endpoint() (in module pyninja.monitor.routes)</a>
@@ -227,6 +233,10 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.monitor.authenticator.generate_cookie">generate_cookie() (in module pyninja.monitor.authenticator)</a>
+</li>
+      <li><a href="index.html#pyninja.main.generate_hyperlink">generate_hyperlink() (in module pyninja.main)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.enums.APIRouteType.get">get (pyninja.modules.enums.APIRouteType attribute)</a>
 </li>
       <li><a href="index.html#pyninja.features.dockerized.get_all_containers">get_all_containers() (in module pyninja.features.dockerized)</a>
 </li>
@@ -261,10 +271,10 @@ <h2 id="G">G</h2>
       <li><a href="index.html#pyninja.routes.metrics.get_cpu_utilization">get_cpu_utilization() (in module pyninja.routes.metrics)</a>
 </li>
       <li><a href="index.html#pyninja.main.get_desc">get_desc() (in module pyninja.main)</a>
-</li>
-      <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_disk">get_disk (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
       <li><a href="index.html#pyninja.monitor.resources.get_disk_info">get_disk_info() (in module pyninja.monitor.resources)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_disk_utilization">get_disk_utilization (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
       <li><a href="index.html#pyninja.routes.metrics.get_disk_utilization">get_disk_utilization() (in module pyninja.routes.metrics)</a>
 </li>
@@ -289,11 +299,11 @@ <h2 id="G">G</h2>
       <li><a href="index.html#pyninja.routes.orchestration.get_docker_volumes">get_docker_volumes() (in module pyninja.routes.orchestration)</a>
 </li>
       <li><a href="index.html#pyninja.monitor.config.get_expiry">get_expiry() (in module pyninja.monitor.config)</a>
-</li>
-      <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_file">get_file (pyninja.modules.enums.APIEndpoints attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_file">get_file (pyninja.modules.enums.APIEndpoints attribute)</a>
+</li>
       <li><a href="index.html#pyninja.routes.fullaccess.get_file">get_file() (in module pyninja.routes.fullaccess)</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.get_ip">get_ip (pyninja.modules.enums.APIEndpoints attribute)</a>
@@ -528,6 +538,8 @@ <h2 id="M">M</h2>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.monitor">monitor (pyninja.modules.enums.APIEndpoints attribute)</a>
 
       <ul>
+        <li><a href="index.html#pyninja.modules.enums.APIRouteType.monitor">(pyninja.modules.enums.APIRouteType attribute)</a>
+</li>
         <li><a href="index.html#pyninja.modules.enums.Cookies.monitor">(pyninja.modules.enums.Cookies attribute)</a>
 </li>
       </ul></li>
@@ -574,6 +586,8 @@ <h2 id="P">P</h2>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.parse_api_secret">parse_api_secret() (pyninja.modules.models.EnvConfig class method)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.parse_apikey">parse_apikey() (pyninja.modules.models.EnvConfig class method)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.enums.APIRouteType.post">post (pyninja.modules.enums.APIRouteType attribute)</a>
 </li>
       <li><a href="index.html#pyninja.executors.routers.post_api">post_api() (in module pyninja.executors.routers)</a>
 </li>
@@ -798,15 +812,21 @@ <h2 id="R">R</h2>
 </li>
       <li><a href="index.html#pyninja.modules.models.EnvConfig.remote_execution">remote_execution (pyninja.modules.models.EnvConfig attribute)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.executors.database.remove_record">remove_record() (in module pyninja.executors.database)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#pyninja.monitor.drive.report">report() (in module pyninja.monitor.drive)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.retrieve_library_path">retrieve_library_path() (in module pyninja.modules.models)</a>
 </li>
       <li><a href="index.html#pyninja.modules.enums.APIEndpoints.root">root (pyninja.modules.enums.APIEndpoints attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.RoutingHandler.routes">routes (pyninja.modules.models.RoutingHandler attribute)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.RoutingHandler">RoutingHandler (class in pyninja.modules.models)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.RoutingHandler.Config">RoutingHandler.Config (class in pyninja.modules.models)</a>
 </li>
       <li><a href="index.html#pyninja.modules.models.Session.rps">rps (pyninja.modules.models.Session attribute)</a>
 </li>
@@ -905,6 +925,8 @@ <h2 id="T">T</h2>
       <li><a href="index.html#pyninja.modules.payloads.RunCommand.timeout">timeout (pyninja.modules.payloads.RunCommand attribute)</a>
 </li>
       <li><a href="index.html#pyninja.executors.squire.total_mountpoints_usage">total_mountpoints_usage() (in module pyninja.executors.squire)</a>
+</li>
+      <li><a href="index.html#pyninja.modules.models.RoutingHandler.type">type (pyninja.modules.models.RoutingHandler attribute)</a>
 </li>
   </ul></td>
 </tr></table>
diff --git a/docs/index.html b/docs/index.html
index 24142ef..f448027 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
     <title>Welcome to PyNinja’s documentation! &#8212; PyNinja  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
@@ -64,16 +64,22 @@ <h1>Welcome to PyNinja’s documentation!<a class="headerlink" href="#welcome-to
 </section>
 <section id="module-pyninja.main">
 <span id="pyninja-main"></span><h1>PyNinja - Main<a class="headerlink" href="#module-pyninja.main" title="Permalink to this heading">¶</a></h1>
+<dl class="py function">
+<dt class="sig sig-object py" id="pyninja.main.generate_hyperlink">
+<span class="sig-prename descclassname"><span class="pre">pyninja.main.</span></span><span class="sig-name descname"><span class="pre">generate_hyperlink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">route</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">fastapi.routing.APIRoute</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">fastapi.routing.APIWebSocketRoute</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#pyninja.main.generate_hyperlink" title="Permalink to this definition">¶</a></dt>
+<dd><p>Generates hyperlink for a particular API route.</p>
+</dd></dl>
+
 <dl class="py function">
 <dt class="sig sig-object py" id="pyninja.main.get_desc">
-<span class="sig-prename descclassname"><span class="pre">pyninja.main.</span></span><span class="sig-name descname"><span class="pre">get_desc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">get_api</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">post_api</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">monitoring_ui</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#pyninja.main.get_desc" title="Permalink to this definition">¶</a></dt>
+<span class="sig-prename descclassname"><span class="pre">pyninja.main.</span></span><span class="sig-name descname"><span class="pre">get_desc</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">get_routes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyninja.modules.models.RoutingHandler" title="pyninja.modules.models.RoutingHandler"><span class="pre">RoutingHandler</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">post_routes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyninja.modules.models.RoutingHandler" title="pyninja.modules.models.RoutingHandler"><span class="pre">RoutingHandler</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">monitor_routes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#pyninja.modules.models.RoutingHandler" title="pyninja.modules.models.RoutingHandler"><span class="pre">RoutingHandler</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#pyninja.main.get_desc" title="Permalink to this definition">¶</a></dt>
 <dd><p>Construct a detailed description for the API docs.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>get_api</strong> – Boolean flag to indicate basic API state.</p></li>
-<li><p><strong>post_api</strong> – Boolean flag to indicate remote execution state.</p></li>
-<li><p><strong>monitoring_ui</strong> – Boolean flag to indicate monitoring page state.</p></li>
+<li><p><strong>get_routes</strong> – RoutingHandler object for GET endpoints.</p></li>
+<li><p><strong>post_routes</strong> – RoutingHandler object for POST endpoints.</p></li>
+<li><p><strong>monitor_routes</strong> – RoutingHandler object for MONITOR endpoints.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -1713,11 +1719,6 @@ <h1>PyNinja - Modules<a class="headerlink" href="#pyninja-modules" title="Permal
 <span class="sig-name descname"><span class="pre">run_command</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/run-command'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIEndpoints.run_command" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py attribute">
-<dt class="sig sig-object py" id="pyninja.modules.enums.APIEndpoints.get_disk">
-<span class="sig-name descname"><span class="pre">get_disk</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/get-disk'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIEndpoints.get_disk" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyninja.modules.enums.APIEndpoints.get_memory">
 <span class="sig-name descname"><span class="pre">get_memory</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/get-memory'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIEndpoints.get_memory" title="Permalink to this definition">¶</a></dt>
@@ -1728,6 +1729,11 @@ <h1>PyNinja - Modules<a class="headerlink" href="#pyninja-modules" title="Permal
 <span class="sig-name descname"><span class="pre">get_all_disks</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/get-all-disks'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIEndpoints.get_all_disks" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.enums.APIEndpoints.get_disk_utilization">
+<span class="sig-name descname"><span class="pre">get_disk_utilization</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/get-disk-utilization'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIEndpoints.get_disk_utilization" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="pyninja.modules.enums.APIEndpoints.get_docker_images">
 <span class="sig-name descname"><span class="pre">get_docker_images</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/get-docker-images'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIEndpoints.get_docker_images" title="Permalink to this definition">¶</a></dt>
@@ -1863,6 +1869,30 @@ <h1>PyNinja - Modules<a class="headerlink" href="#pyninja-modules" title="Permal
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="pyninja.modules.enums.APIRouteType">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.modules.enums.</span></span><span class="sig-name descname"><span class="pre">APIRouteType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyninja.modules.enums.APIRouteType" title="Permalink to this definition">¶</a></dt>
+<dd><p>Types of API routes available.</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">APIRouteType</span>
+</pre></div>
+</div>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.enums.APIRouteType.get">
+<span class="sig-name descname"><span class="pre">get</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'get'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIRouteType.get" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.enums.APIRouteType.post">
+<span class="sig-name descname"><span class="pre">post</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'post'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIRouteType.post" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.enums.APIRouteType.monitor">
+<span class="sig-name descname"><span class="pre">monitor</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'monitor'</span></em><a class="headerlink" href="#pyninja.modules.enums.APIRouteType.monitor" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 </section>
 <section id="module-pyninja.modules.exceptions">
 <span id="exceptions"></span><h2>Exceptions<a class="headerlink" href="#module-pyninja.modules.exceptions" title="Permalink to this heading">¶</a></h2>
@@ -1930,6 +1960,42 @@ <h1>PyNinja - Modules<a class="headerlink" href="#pyninja-modules" title="Permal
 <section id="models">
 <h2>Models<a class="headerlink" href="#models" title="Permalink to this heading">¶</a></h2>
 <dl class="py class">
+<dt class="sig sig-object py" id="pyninja.modules.models.RoutingHandler">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.modules.models.</span></span><span class="sig-name descname"><span class="pre">RoutingHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">BaseModel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyninja.modules.models.RoutingHandler" title="Permalink to this definition">¶</a></dt>
+<dd><p>Routing handler to update the API routes to the server.</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">RoutingHandler</span>
+</pre></div>
+</div>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.models.RoutingHandler.type">
+<span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#pyninja.modules.enums.APIRouteType" title="pyninja.modules.enums.APIRouteType"><span class="pre">APIRouteType</span></a></em><a class="headerlink" href="#pyninja.modules.models.RoutingHandler.type" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.models.RoutingHandler.routes">
+<span class="sig-name descname"><span class="pre">routes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">fastapi.routing.APIRoute</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">fastapi.routing.APIWebSocketRoute</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#pyninja.modules.models.RoutingHandler.routes" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.models.RoutingHandler.enabled">
+<span class="sig-name descname"><span class="pre">enabled</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#pyninja.modules.models.RoutingHandler.enabled" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="pyninja.modules.models.RoutingHandler.Config">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Config</span></span><a class="headerlink" href="#pyninja.modules.models.RoutingHandler.Config" title="Permalink to this definition">¶</a></dt>
+<dd><p>Configuration for routing handler.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="pyninja.modules.models.RoutingHandler.Config.arbitrary_types_allowed">
+<span class="sig-name descname"><span class="pre">arbitrary_types_allowed</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">True</span></em><a class="headerlink" href="#pyninja.modules.models.RoutingHandler.Config.arbitrary_types_allowed" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
+</dd></dl>
+
+<hr class="docutils" />
+<dl class="py class">
 <dt class="sig sig-object py" id="pyninja.modules.models.ServiceStatus">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyninja.modules.models.</span></span><span class="sig-name descname"><span class="pre">ServiceStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">BaseModel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyninja.modules.models.ServiceStatus" title="Permalink to this definition">¶</a></dt>
 <dd><p>Object to load service status with a status code and description.</p>
diff --git a/docs/objects.inv b/docs/objects.inv
index 1818bfd47a27468861565fe6b26728a1179e7766..89955916e1db4733279b0e285e9886106c663350 100644
GIT binary patch
delta 2332
zcmV+%3FG#h68aL5cYn=t<hBvV@B0*!O0LVwrcychwzXDbSJ_#W<dlyn4B0aS3j|;Q
z9BF*YYvlFvBxwL7=R=fCG?0^|8UBCxAU?Vq4VjY?>KER?3$%mR)-`<ahmARX)9Y@K
zu=(>ws19D5gYV@Z(`O(5wE6hKEDD>u`>$WV3-aBdS}(NPe1EzGyrbM{yA@priljbp
z)k$FCcLvsKOQHzXTIfM}py?$XL9$N;+P~y#JMQ_GJ0QKXN!;wgGYhS@9ku+%48;iS
zdwm2V#p(fHn<MqZsBJpkIxM~uSOrh4K<rCy1XX?jF4GL8sC%sheo)+qkt5We4dkX6
z?MPkWejTv#q<=S=qz!ittY_vlbizH+%AX)!KY?;YMyvatGY5uS?(<irnWB!NDh_9c
z>Zo<;PKx)UWoqcR<4hq?Kpl4ims+WL2h;}PV&8Mmly+qRFM8-edQQZQ+r~4u_`sf8
znZwX?C4K`oIKBtggSVok!k*x?&))<`ad;_=+x8$lPJjL(O(H4>-!xHftT=KHOc=(y
z&VqAfkZw`U;xtknl`?E4j{D-;xbTk0xkw)RUVAQCuLtFg7RtLcYSz(qz{6XOJJl0d
ztWTG*OfIO?ZY5=CmghpPUKieDi5?qNfpgSy=u1I!!<h5<L?O)%Dy$S$x(n-LFX~qU
z(uT~@27hpC!e<?2B%Rew2RlAUPcA<8?=<0s+UYV9?%hYx0yCnk24YgE;iVp~=dE`2
zaL=gK&jrA#_eblG4w`C31C7<7jK@)$#uC_QCa4x@6}TFaq}5~W2TDsu>AV<@e-mqP
z)fBz`WwmRt2%27RNuM<1Qc6^(#q*+nNeo;!%YP9DI-+_|{K$pmTM1;slhV&C&BY$~
zhm4^Z9>>?M!mI{%IN^N4_3vqYS#hj%;Mxqy<hU|;X~6^mOGdiQfW*PE^7+_q*R;Gn
z<jm76T@(EfHZ#^23+RkFLa|ZTe7^twPIbwQ43Ji$&$_bED{+i`1OoTyyKK>YCsF3e
zTYnj5TJnPL?&{$#SI}}|Yldo|=uFq4g+6107gGEd_u@*_Xl&kCz16U1f1w&O>`Zlu
z7tTmIGel78kc6qj>7m#5REPE2WU9xUo#krCS}WFTqo^LUQmfCg<uZ;GE{)*|&6IjC
zR27UKd^zXBV<`iL^N>2z98DtKR={Xop?`nSYQK!emBEq`f4jNV;$B$xr8x8x{vWlx
zc0bB!&$!;6oQIx@dI+aBKcSURu_R}4Shk95P&y0Gpl}35qI}W%NkG0;J?fgyiX)Vi
zT+{~>!{PoGT&Q@4MIwDoK^?V!oCjA{f86Msj@xHZr7F!Fj4LKx1kSQqKS6IKI)BLd
zLuFPr(P+0|bXX1P9kdLjchi{{A1`DS?9gY(6v8M#jB}!pGN_QXq30u*9MlxqAUXcC
zI4*SH4E`Dyn)#cY8Z-}Myyb3IlTnYUWACOQ0FCl5^*ER?aH0G9NXJ+%95C&2vVkTH
z{sc*RIZ4=jzBzzhxhgEEoBSxl5`TpfNLk|SskQm`B1<W+HzsA%S_olCKLtyB!0Fem
z=G>{{7p-<;pI?Pp+SDT8K=qc>y7Cq4AUa?|1%E@RG~8V&ni~<4O>DL;w?uk^Qz_*#
z%dLnL_C+bSRXAyXEk*6D?nA1@>?~3Tc9@+t+J^gd@N&k1UP9{mOCTv|=YQR<2sh@o
z8Jv30V}@W29?c+l6E~nsr+8mHR^!*~kng~}L8>uWm1a|Za0$k6i<|THB10bbGi+RE
z=%5r2gyMlZ2Nr8g$9VWAMK6k9UP!M+R?0}KFyN=)WQ9f&k7izTdLBI<Vuc>CuYZ`j
zI&X`grE%4>@aq81yTWQT7k>$#1Pr=c=;MBOK0eKC(v_ZU{48P`Znpw$AbVo|WWa?3
zI{ge?jh3RX7L3F?teDGO<pnf;jIHH^9@F%AoKF_=-oTZ-2?z3482Soujhj{h`j&UY
zi$BnA=*YNvJJ0Q=C~U@|$k4gp3#!>N!@`Y}He`Edhm3DX>4HodV}DAkqZ6zlcF50<
z<QFqbn^p=?zQ6`Kql7wgN$t;8_eR2t@F&(DARG)(A`DZ?B)i#3vpF_ooWn5!;+kss
z+AAaz$?#K1LU7GL!2f;pL{`3~TWJ$KnW+XDeLHi05H5lor4q9kdlw9IEmy_$Xi|(U
z|A2e}B~&X1^w=k)$ba5l7NG8+pV=W^pCg^i&d7&BeL0`*<@Wtq-O$bmmq;PEDnD?1
zZ8m4d@y_D2EtX|LEd%h~i!5IU&A-7?veJ^U2_cie{grhv?WXJ3gKGjPGNI+N9c0WP
z<nBO19N?v-4MCpQfau7_ts8e6(M~tFR=<P=eG2)to}s_ng?~@EbOqIEb{wa9$8OCF
zDsE2mY~#sc2`WY2v%>C6nCa-U7!<ep(6oy<519p4>`rXXSy|6HN7OP$Q4*r%1KiS@
zFcLyO5xf|YHnH{c`6N5D;!!u5S=j%CQk!##b-mJp(}Nv@37K`Cwaxk3P|VMqHWETL
zn%uiWuL)C{sDA<cQ~451j9jn3UGoOyCdrb@(dhT@m3BD2@@`Eo<5K=hDM_Ny5w3Wd
z)wl9qGkR{SbkcZ%xwJ`R$6U>f49*+^$(>D6n6kog2Tqwvl(JKjU@-!JDPv3_{vyaT
zY+V={xpf)kyFp6cX5No_rM=2RCX{`X0!krVCP-5BH-DLks}aJ4Tfq69mvm#&b>2<l
zY51IHabD4*@b$%r+@h~8958;|7eQ{W8IU+j_Z3K>l)z3#h47^_JnOFBt(16IZxKVe
zcK9wR<Cgh*99;dTNG}mYxjgtTsHA0tYlI7o+-rm*LfiHL&f9sk=8d~6`P<iYXw_N1
zpHt4tFn@=B50&-r0Ty9z=bw{-Z)A$U&3m}}{Oyl-8|S-kLYn`_Pn+~fd}4Ed`e!KZ
z1N!GF2Qxe;`4(h&a{4qq`+fNJ!}+lhck#r}AaTcpjn@<SzyJP^+u(yk_^(&74S)E6
zBW|HAbNV=akzhZj!J10F`1W^X_a}eAez;OQ2o?Xc<XV_MOPa^@{XGuD5B~!jd=s1v
C;g^2^

delta 2237
zcmV;u2txPz5}Xo{cYn)r?6whx_j-y+CELTwak;Ya?$ogoyUNZ{Nltl*!jL^fSReoc
z;EcwryoO&dPZC@R&P9|=G~kt_8U7y{O<Wp4L+T`$_=Ps`0_|v}HVqwZzfq@e2HA}q
zHh<qR(ZNg8+kyWze)i#Sn-6ztQP|u+eEIyHm+wZ=S|-Kj<9{XK9pz5yE$ccED0NRo
z$AS3Y31}@fio!&zVE|zPr{{10PCgcBzsl8i)Y2_AfO=&~-0Z;;4XxB2w){qo#R%tn
zc>p9u%hA0ygYv_qZ93T+SA55u2^MKU@Fi6YEAN5w*aI=@K?>$RD6YiBVPa24bXAlz
zC|8(YM`t|hO@BsdLyZA#i8_rPGtap46U54A5C+L;<uFiUKv7L?{-`ul#KD_lT+a|4
z)|T!h=)hVc#$h}46a)ptVaME1%O&jqTOl{t57ZJNO&P$l0XpE8A~DmnairQku*VwH
zj{_C#Hz1>-dmsZ?%~~w%8BY8BNpKSTmqMs+duCndAAe&f!gAc3M#`0D2Wo*ZMQGP)
zFa`~hty7cGjYNl~j9c#7eX%vhzvHPdqMN>zmU1%4QCKCJuqL*eb+jE&|5n3H^$gnC
z(`5{k3+gyqaqg>SDHE&5h4)x&a22Y+IY>SZrJ%WD#8~%4Ax)3Mj}%qh<?PWH_LYF7
zLUW`7H-9y`XAPz$oz+bTJ34ZUE<X4-b$BLrvW(>B?gMLqDArX25zfT;QV%!KR+@Ua
zqtnV`0Wf)givIARWEBoHnSp7KlQgy^&>>6^E#M5eYLTeXWAX#0CX;j?45z=57F<<D
zZhu+5G*|?s*IVL~W*SP7>Nt2__!q@+<7PQRL4Su-kAfa3<8;dbO?VdaxH4QE-29Ny
z6#e7jb$4Le^(8cE?MdLJ1?2@K#@RXp65j91=Y#2{X=&T%bhRs86P6NWW~?t3+<M9&
ziVeEv)5G`oqKlEBhqT-+J69HZB@UYxo<OZzer(+e97UNo&&n`q)bh)3QxA7J2$mCD
zHGftEh4pY9TH3OxKngM9O|V)Gdk*ufA^n6>mw2&;C};YOk2)l#>Tm`aq(0SQy^eJ1
zG3PaIHDs+(>UAtrk6EeK=Pltf4reB|;R@B{avy_<VvHPZIp<=bQ3mqI7<Ib23xi}^
z0V8Dv|F~fLaucl#7Gv+*$)y(eA|NltxqtBf&#>}()lfz|y7Bg8EDR{rXDOc<<OhzE
zuIV&8KuO6(9WODA8_xYIA)K_JNMGXCgV;aKzRdE+jlSuqKC&vNH1n2GG3jD^C!6&X
z42n~WXezU^@o_29prr5ocn2*5@oqZv!sCUEf(hviNek@)#MCDWDWmYY1#&(p$bUhl
z#XD+kJB$5j_XtM0U&BB%f0JWD^EhoO+|Oz>>M1(*KCN?cl>dmQQTc`o-IpgkMpI^h
zNRyMZk}&QkaLmhz!sgS>G2zNlVL{#GFQk_!n7x7}&K_&cw->oIdEQ9Mrq$pNK5g34
z8^CqHZZ+p#96n32WBYs)W@%H4;C~vb)fDH-SFE0OK$!61H50M9n^H7Y%%?<XuoXzp
za4Mx-=3*6b{JhB7whAZCucfG+mV-|SnAb+whV6T2jk>vc+6VPhLoXo>^u?0|wDW9N
zgqt$3l<RuODUYoN4;K);i5uMtM$n<St%k2jFO983s?k`5Bq@uv1f!^SlYjH|AcJo9
zGi(}X@SwQ;1;q_@-bbs^9krkJI2%~;%kxQ~jurD}Dm3`C7gwQ@$kT_{oPmZF57MAV
z=j$JmtMjJ#SsF$?4Zn_HtSL03xkyXQ$2>)+KF!;&c{RF{H~yqjGlg$A*SOSn@B`%y
zFZ^(`O^3$KlR&PUg0P{S%YP$u#4QQ;Oqe1oLf*Qo%$V}!@uZmiU&cr&LwJH#NQeCV
zgnluzv}rj5VGCxiGm41=<ye2Va!?#zm_3oU2furYS(m1CFmf~gW^=U9riDWQXsS;x
zuv(iQpGb<H{OPP|{ss1*Q~bK}E!|2RAO9u`GJHF8eqbhm4919A?0>uqikOy)Vmq3+
zvyy*`xPW4!<)d5YB_zw9D;J=qmq*fvt3jy4s~Pz?iqGdGkX+xN)eY_-Wr^gIPV%=K
zuY;}3-Ji4gJcGwBzS1Mh0Qc@$R)p+=hEZeEb)vBG3+;b=O*%-k>H6{Dng9Y#Xen<;
zztc*3YI+o+hnJE%cz=0b1;X+#Ox<p_VQspVvic<~=;KCFYl&MWb^cSzO@TShj=FB%
zk=yVBi`#>M&}iFm-c*8$`?Xn{wM&?E;8hF?)4Z?R#qI!_1)A+nWIotm&pGeIWVWIx
zbde8GjjO^$@JSc&qF9{7*30Mf&rHLEE`?dn|A<nX^TynIrGEw^M?Eb;Gi{!=&G|}1
zNL))33Brsf_a4M+Ldu_0;Qkc01QYf<*WVm?19FpzhUG{@=w3+Ux>w$fuw`6K5-25c
z7j*dRD{A$Pqt}dqswz&JE@zfjX>!a}&&c5TtE#Bp6ofHd*3G~%odZ*L%%mztxL?W`
zX=Atua)hn%O@AZTmPx)FIj3#r-H%t=t5i)y**AG|7{X;18AgATuC*G$l)vGa@4Tp+
zGE?(zNv7s=?!|dUPr}z3<GDp&WnvS0*cU-Y%Q*Xu+SL)s0w)Y_H9#@T7mf1UmqyX7
zdq}rZ<UOQC4CYGJyP%94wC{1;=$CeSks!>)sCPjnHGe}~ky>EnUXhv*Qnx)AtLN65
z*Y2+5Z{KCWnX`O}p`4Ww4*d}->+16&?Cm67H1Lgd+P8U+_n*G~@qS}$_l?hm{_t@V
zKM7B49!~%ErQNypdCc7N&vCj1?w?Gb#%I6xzuui6n{XFT{0!X9n6R-jf&cg4-_6E7
zIQswS6E^Dbmpj+u7Rpkm59x~t`!P1wSn9>Me;|7}+1~l#N^QXZKZa{z{48po;`a}(
L8Q%RLt0?YNrVwl*

diff --git a/docs/searchindex.js b/docs/searchindex.js
index 6862688..1fc6428 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNinja", "Welcome to PyNinja\u2019s documentation!"], "terms": {"lightweight": 0, "o": [0, 1], "agnost": [0, 1], "servic": 0, "monitor": 0, "api": 0, "platform": 0, "support": [0, 1], "deploy": 0, "recommend": 0, "instal": [0, 1], "python": 0, "3": [0, 1], "10": [0, 1], "11": [0, 1], "us": [0, 1], "dedic": 0, "virtual": [0, 1], "m": 0, "pip": 0, "For": 0, "linux": [0, 1], "machin": [0, 1], "extra": [0, 1], "includ": [0, 1], "function": [0, 1], "from": [0, 1], "pyudisk": [0, 1], "": 0, "A": [0, 1], "r": 0, "t": [0, 1], "metric": [0, 1], "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "start": [0, 1], "cli": 0, "help": 0, "usag": [0, 1], "instruct": 0, "sourc": 0, "an": [0, 1], "env": [0, 1], "file": [0, 1], "By": 0, "default": [0, 1], "look": 0, "current": [0, 1], "work": [0, 1], "directori": [0, 1], "apikei": [0, 1], "kei": [0, 1], "authent": 0, "ninja": 0, "_": 0, "host": [0, 1], "hostnam": [0, 1], "server": [0, 1], "port": [0, 1], "number": [0, 1], "remot": [0, 1], "execut": [0, 1], "boolean": [0, 1], "flag": [0, 1], "enabl": [0, 1], "secret": [0, 1], "access": [0, 1], "run": [0, 1], "command": [0, 1], "disk": [0, 1], "report": [0, 1], "featur": 0, "udisk": 0, "lib": [0, 1], "librari": [0, 1], "usernam": [0, 1], "page": [0, 1], "password": [0, 1], "session": [0, 1], "timeout": [0, 1], "NO": 0, "auth": [0, 1], "without": 0, "max": [0, 1], "connect": [0, 1], "maximum": [0, 1], "allow": [0, 1], "parallel": 0, "process": 0, "list": [0, 1], "name": [0, 1], "gpu": [0, 1], "filepath": [0, 1], "memori": [0, 1], "processor": [0, 1], "databas": 0, "store": [0, 1], "handl": [0, 1], "error": [0, 1], "rate": [0, 1], "limit": [0, 1], "dictionari": [0, 1], "max_request": [0, 1], "second": [0, 1], "appli": [0, 1], "log": [0, 1], "config": [0, 1], "configur": 0, "path": [0, 1], "can": [0, 1], "extrem": 0, "riski": 0, "major": 0, "secur": 0, "threat": 0, "so": [0, 1], "caution": 0, "set": [0, 1], "strong": [0, 1], "valu": [0, 1], "refer": [0, 1], "sampl": 0, "exampl": [0, 1], "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "pre": 0, "commit": 0, "ensur": [0, 1], "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": 0, "all": [0, 1], "markdown": 0, "wiki": 0, "sphinx": 0, "5": [0, 1], "1": [0, 1], "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "get_desc": 1, "get_api": 1, "bool": 1, "post_api": 1, "monitoring_ui": 1, "str": 1, "construct": 1, "detail": 1, "descript": 1, "doc": 1, "paramet": 1, "basic": 1, "state": 1, "return": 1, "string": 1, "type": 1, "async": 1, "redirect_exception_handl": 1, "request": 1, "redirectexcept": 1, "jsonrespons": 1, "custom": 1, "handler": 1, "redirect": 1, "take": 1, "object": 1, "argument": 1, "inherit": 1, "statu": 1, "cooki": 1, "kwarg": 1, "none": 1, "starter": 1, "which": 1, "uvicorn": 1, "trigger": 1, "keyword": 1, "env_fil": 1, "load": 1, "ninja_host": 1, "ninja_port": 1, "remote_execut": 1, "api_secret": 1, "monitor_usernam": 1, "monitor_password": 1, "monitor_sess": 1, "service_manag": 1, "manag": 1, "rate_limit": 1, "log_config": 1, "dict": 1, "yaml": 1, "yml": 1, "json": 1, "ini": 1, "epoch": 1, "forbidden": 1, "i": 1, "part": 1, "fastapi": 1, "rais": 1, "apirespons": 1, "403": 1, "If": 1, "address": 1, "level_1": 1, "httpauthorizationcredenti": 1, "httpbearer": 1, "author": 1, "header": 1, "token": 1, "401": 1, "invalid": 1, "level_2": 1, "addition": 1, "addit": 1, "critic": 1, "increment": 1, "attempt": 1, "int": 1, "block": 1, "time": 1, "base": 1, "fail": 1, "login": 1, "appropri": 1, "minut": 1, "handle_auth_error": 1, "filebrows": 1, "The": 1, "incom": 1, "get_record": 1, "get": 1, "particular": 1, "until": 1, "when": 1, "should": 1, "put_record": 1, "block_until": 1, "insert": 1, "remove_record": 1, "delet": 1, "record": 1, "relat": 1, "fullaccess": 1, "run_command": 1, "runcommand": 1, "depend": 1, "option": 1, "arg": 1, "receiv": 1, "bodi": 1, "httpstatu": 1, "respons": 1, "list_fil": 1, "listfil": 1, "fileio": 1, "download": 1, "upload": 1, "get_fil": 1, "getfil": 1, "filerespons": 1, "put_fil": 1, "uploadfil": 1, "overwrit": 1, "fals": 1, "th": 1, "param": 1, "ipaddr": 1, "get_ip_address": 1, "public": 1, "local": 1, "ip": 1, "devic": 1, "privat": 1, "get_cpu_util": 1, "interv": 1, "float": 1, "2": 1, "per_cpu": 1, "true": 1, "cpu": 1, "util": 1, "each": 1, "get_memory_util": 1, "get_cpu_load_avg": 1, "system": 1, "queue": 1, "averag": 1, "over": 1, "last": 1, "15": 1, "respect": 1, "get_disk_util": 1, "get_all_disk": 1, "attach": 1, "namespac": 1, "get_process_statu": 1, "process_nam": 1, "cpu_interv": 1, "union": 1, "check": 1, "get_service_usag": 1, "service_nam": 1, "comma": 1, "separ": 1, "get_process_usag": 1, "get_all_servic": 1, "get_service_statu": 1, "stop_servic": 1, "stop": 1, "start_servic": 1, "get_processor_nam": 1, "inform": 1, "orchestr": 1, "get_docker_contain": 1, "container_nam": 1, "get_al": 1, "get_run": 1, "contain": 1, "stop_docker_contain": 1, "start_docker_contain": 1, "get_docker_imag": 1, "imag": 1, "get_docker_volum": 1, "volum": 1, "get_docker_stat": 1, "stat": 1, "router": 1, "monitor_redirect": 1, "redirectrespons": 1, "user": 1, "docs_redirect": 1, "health": 1, "200": 1, "apirout": 1, "ad": 1, "apiwebsocketrout": 1, "applic": 1, "inject": 1, "websocket": 1, "public_ip_address": 1, "differ": 1, "endpoint": 1, "private_ip_address": 1, "simpl": 1, "network": 1, "see": 1, "format_no": 1, "input_": 1, "remov": 1, "0": 1, "integ": 1, "end": 1, "found": 1, "els": 1, "format_timedelta": 1, "td": 1, "timedelta": 1, "convert": 1, "human": 1, "readabl": 1, "non": 1, "zero": 1, "alwai": 1, "output": 1, "two": 1, "identifi": 1, "dai": 1, "hour": 1, "23": 1, "size_convert": 1, "byte_s": 1, "consum": 1, "friendli": 1, "byte": 1, "size": 1, "process_command": 1, "result": 1, "stdout": 1, "stderr": 1, "pair": 1, "envfile_load": 1, "filenam": 1, "pathlik": 1, "envconfig": 1, "filetyp": 1, "where": 1, "var": 1, "have": 1, "load_env": 1, "merg": 1, "give": 1, "prioriti": 1, "thi": 1, "partial": 1, "through": 1, "load_architectur": 1, "architectur": 1, "keygen": 1, "ar": 1, "forc": 1, "restart": 1, "url": 1, "safe": 1, "64": 1, "bit": 1, "dynamic_numb": 1, "dynam": 1, "assert_pyudisk": 1, "disk_report": 1, "onli": 1, "udiskctl": 1, "assert_token": 1, "least": 1, "ani": 1, "handle_warn": 1, "warn": 1, "comma_separ": 1, "list_": 1, "join": 1, "input": 1, "length": 1, "element": 1, "convert_second": 1, "n_elem": 1, "calcul": 1, "year": 1, "month": 1, "given": 1, "notion": 1, "humanize_usage_metr": 1, "total_mountpoints_usag": 1, "mountpoint": 1, "as_byt": 1, "sum": 1, "up": 1, "locat": 1, "get_container_statu": 1, "get_running_contain": 1, "yield": 1, "correspond": 1, "get_all_contain": 1, "get_all_imag": 1, "get_all_volum": 1, "stop_contain": 1, "start_contain": 1, "get_process_info": 1, "proc": 1, "psutil": 1, "statist": 1, "process_monitor": 1, "case": 1, "sensit": 1, "thei": 1, "strictli": 1, "match": 1, "maco": 1, "top": 1, "grep": 1, "window": 1, "task": 1, "service_monitor": 1, "follow": 1, "right": 1, "launchctl": 1, "systemctl": 1, "show": 1, "properti": 1, "mainpid": 1, "sc": 1, "queri": 1, "get_service_pid": 1, "retriev": 1, "pid": 1, "get_service_pid_linux": 1, "get_service_pid_maco": 1, "get_service_pid_window": 1, "perform": 1, "get_perform": 1, "thread": 1, "open": 1, "servicestatu": 1, "501": 1, "unknown": 1, "503": 1, "unavail": 1, "404": 1, "get_process_object": 1, "creat": 1, "avail": 1, "instanc": 1, "timed_cach": 1, "max_ag": 1, "maxsiz": 1, "128": 1, "recent": 1, "decor": 1, "live": 1, "functool": 1, "lru_cach": 1, "distinct": 1, "even": 1, "one": 1, "chang": 1, "map": 1, "new": 1, "entri": 1, "thu": 1, "refresh": 1, "just": 1, "trick": 1, "provid": 1, "ttl": 1, "monoton": 1, "sinc": 1, "reli": 1, "clock": 1, "mai": 1, "guarante": 1, "increas": 1, "fact": 1, "decreas": 1, "sync": 1, "its": 1, "class": 1, "operatingsystem": 1, "qualnam": 1, "boundari": 1, "darwin": 1, "apiendpoint": 1, "root": 1, "redoc": 1, "put": 1, "get_processor": 1, "ws_system": 1, "w": 1, "get_disk": 1, "get_memori": 1, "get_ip": 1, "get_cpu": 1, "get_cpu_load": 1, "logout": 1, "session_token": 1, "templat": 1, "html": 1, "index": 1, "unauthor": 1, "disk_report_linux": 1, "disk_report_darwin": 1, "status_cod": 1, "httpexcept": 1, "wrap": 1, "unsupportedo": 1, "unsupport": 1, "within": 1, "doesn": 1, "demand": 1, "solut": 1, "There": 1, "altern": 1, "our": 1, "javascript": 1, "wai": 1, "come": 1, "handi": 1, "mani": 1, "unexpect": 1, "scenario": 1, "tiangolo": 1, "com": 1, "tutori": 1, "sessionerror": 1, "raise_os_error": 1, "operating_system": 1, "noreturn": 1, "validationerror": 1, "overridden": 1, "pydant": 1, "basemodel": 1, "auth_count": 1, "forbid": 1, "info": 1, "rp": 1, "allowed_origin": 1, "wssession": 1, "client_auth": 1, "smart_lib": 1, "max_connect": 1, "no_auth": 1, "gpu_lib": 1, "disk_lib": 1, "service_lib": 1, "processor_lib": 1, "classmethod": 1, "parse_apikei": 1, "pars": 1, "complex": 1, "parse_api_secret": 1, "from_env_fil": 1, "ignor": 1, "hide_input_in_error": 1, "complexity_check": 1, "min_length": 1, "verifi": 1, "strength": 1, "consid": 1, "ha": 1, "32": 1, "charact": 1, "digit": 1, "symbol": 1, "uppercas": 1, "letter": 1, "lowercas": 1, "assertionerror": 1, "abov": 1, "condit": 1, "default_service_lib": 1, "referenc": 1, "retrieve_library_path": 1, "func": 1, "callabl": 1, "call": 1, "datastor": 1, "sqlite3": 1, "create_t": 1, "table_nam": 1, "column": 1, "tupl": 1, "show_hidden_fil": 1, "include_directori": 1, "deep_scan": 1, "implement": 1, "init": 1, "exce": 1, "429": 1, "too": 1, "calculate_hash": 1, "hash": 1, "base64_encod": 1, "base64": 1, "encod": 1, "base64_decod": 1, "decod": 1, "hex_decod": 1, "hex": 1, "hex_encod": 1, "failed_auth_count": 1, "keep": 1, "track": 1, "more": 1, "raise_error": 1, "bad": 1, "credenti": 1, "extract_credenti": 1, "extract": 1, "befor": 1, "verify_login": 1, "generate_cooki": 1, "auth_payload": 1, "timestamp": 1, "session_error": 1, "htmlrespons": 1, "render": 1, "messag": 1, "jinja2": 1, "validate_sess": 1, "cookie_str": 1, "summari": 1, "clear_sess": 1, "clear": 1, "get_expiri": 1, "lease_start": 1, "lease_dur": 1, "expiri": 1, "datetim": 1, "ag": 1, "wa": 1, "made": 1, "date": 1, "gmt": 1, "ctx": 1, "500": 1, "after": 1, "context": 1, "enter": 1, "landing_pag": 1, "land": 1, "jinja": 1, "get_disk_info": 1, "partit": 1, "physic": 1, "container_cpu_limit": 1, "core": 1, "nanocpu": 1, "map_docker_stat": 1, "json_data": 1, "data": 1, "get_cpu_perc": 1, "percentag": 1, "asynchron": 1, "get_system_metr": 1, "swap": 1, "nest": 1, "get_os_agnostic_metr": 1, "pyudisk_metr": 1, "mean": 1, "60": 1, "avoid": 1, "gather": 1, "everi": 1, "improv": 1, "latenc": 1, "overhead": 1, "system_resourc": 1, "error_endpoint": 1, "logout_endpoint": 1, "out": 1, "login_endpoint": 1, "redirect_url": 1, "monitor_endpoint": 1, "ui": 1, "websocket_endpoint": 1, "fetch": 1, "search": 1}, "objects": {"pyninja.executors": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "database"], [1, 0, 0, "-", "routers"], [1, 0, 0, "-", "squire"]], "pyninja.executors.auth": [[1, 1, 1, "", "EPOCH"], [1, 1, 1, "", "forbidden"], [1, 1, 1, "", "handle_auth_error"], [1, 1, 1, "", "incrementer"], [1, 1, 1, "", "level_1"], [1, 1, 1, "", "level_2"]], "pyninja.executors.database": [[1, 1, 1, "", "get_record"], [1, 1, 1, "", "put_record"], [1, 1, 1, "", "remove_record"]], "pyninja.executors.routers": [[1, 1, 1, "", "docs_redirect"], [1, 1, 1, "", "get_api"], [1, 1, 1, "", "health"], [1, 1, 1, "", "monitor_redirect"], [1, 1, 1, "", "monitoring_ui"], [1, 1, 1, "", "post_api"]], "pyninja.executors.squire": [[1, 1, 1, "", "assert_pyudisk"], [1, 1, 1, "", "assert_tokens"], [1, 1, 1, "", "comma_separator"], [1, 1, 1, "", "convert_seconds"], [1, 1, 1, "", "dynamic_numbers"], [1, 1, 1, "", "envfile_loader"], [1, 1, 1, "", "format_nos"], [1, 1, 1, "", "format_timedelta"], [1, 1, 1, "", "handle_warnings"], [1, 1, 1, "", "humanize_usage_metrics"], [1, 1, 1, "", "keygen"], [1, 1, 1, "", "load_architecture"], [1, 1, 1, "", "load_env"], [1, 1, 1, "", "private_ip_address"], [1, 1, 1, "", "process_command"], [1, 1, 1, "", "public_ip_address"], [1, 1, 1, "", "size_converter"], [1, 1, 1, "", "total_mountpoints_usage"]], "pyninja.features": [[1, 0, 0, "-", "dockerized"], [1, 0, 0, "-", "operations"], [1, 0, 0, "-", "process"], [1, 0, 0, "-", "service"]], "pyninja.features.dockerized": [[1, 1, 1, "", "get_all_containers"], [1, 1, 1, "", "get_all_images"], [1, 1, 1, "", "get_all_volumes"], [1, 1, 1, "", "get_container_status"], [1, 1, 1, "", "get_running_containers"], [1, 1, 1, "", "start_container"], [1, 1, 1, "", "stop_container"]], "pyninja.features.operations": [[1, 1, 1, "", "default"], [1, 1, 1, "", "get_process_info"], [1, 1, 1, "", "get_service_pid"], [1, 1, 1, "", "get_service_pid_linux"], [1, 1, 1, "", "get_service_pid_macos"], [1, 1, 1, "", "get_service_pid_windows"], [1, 1, 1, "", "process_monitor"], [1, 1, 1, "", "service_monitor"]], "pyninja.features.process": [[1, 1, 1, "", "get_performance"], [1, 1, 1, "", "get_process_status"]], "pyninja.features.service": [[1, 1, 1, "", "get_all_services"], [1, 1, 1, "", "get_process_object"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "running"], [1, 1, 1, "", "start_service"], [1, 1, 1, "", "stop_service"], [1, 1, 1, "", "stopped"], [1, 1, 1, "", "unavailable"], [1, 1, 1, "", "unknown"]], "pyninja": [[1, 0, 0, "-", "main"]], "pyninja.main": [[1, 1, 1, "", "get_desc"], [1, 1, 1, "", "redirect_exception_handler"], [1, 1, 1, "", "start"]], "pyninja.modules": [[1, 0, 0, "-", "cache"], [1, 0, 0, "-", "enums"], [1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "models"], [1, 0, 0, "-", "rate_limit"], [1, 0, 0, "-", "secure"]], "pyninja.modules.cache": [[1, 1, 1, "", "timed_cache"]], "pyninja.modules.enums": [[1, 2, 1, "", "APIEndpoints"], [1, 2, 1, "", "Cookies"], [1, 2, 1, "", "OperatingSystem"], [1, 2, 1, "", "Templates"]], "pyninja.modules.enums.APIEndpoints": [[1, 3, 1, "", "docs"], [1, 3, 1, "", "error"], [1, 3, 1, "", "get_all_disks"], [1, 3, 1, "", "get_all_services"], [1, 3, 1, "", "get_cpu"], [1, 3, 1, "", "get_cpu_load"], [1, 3, 1, "", "get_disk"], [1, 3, 1, "", "get_docker_containers"], [1, 3, 1, "", "get_docker_images"], [1, 3, 1, "", "get_docker_stats"], [1, 3, 1, "", "get_docker_volumes"], [1, 3, 1, "", "get_file"], [1, 3, 1, "", "get_ip"], [1, 3, 1, "", "get_memory"], [1, 3, 1, "", "get_process_status"], [1, 3, 1, "", "get_process_usage"], [1, 3, 1, "", "get_processor"], [1, 3, 1, "", "get_service_status"], [1, 3, 1, "", "get_service_usage"], [1, 3, 1, "", "health"], [1, 3, 1, "", "list_files"], [1, 3, 1, "", "login"], [1, 3, 1, "", "logout"], [1, 3, 1, "", "monitor"], [1, 3, 1, "", "put_file"], [1, 3, 1, "", "redoc"], [1, 3, 1, "", "root"], [1, 3, 1, "", "run_command"], [1, 3, 1, "", "start_docker_container"], [1, 3, 1, "", "start_service"], [1, 3, 1, "", "stop_docker_container"], [1, 3, 1, "", "stop_service"], [1, 3, 1, "", "ws_system"]], "pyninja.modules.enums.Cookies": [[1, 3, 1, "", "drive"], [1, 3, 1, "", "monitor"], [1, 3, 1, "", "session_token"]], "pyninja.modules.enums.OperatingSystem": [[1, 3, 1, "", "darwin"], [1, 3, 1, "", "linux"], [1, 3, 1, "", "windows"]], "pyninja.modules.enums.Templates": [[1, 3, 1, "", "disk_report_darwin"], [1, 3, 1, "", "disk_report_linux"], [1, 3, 1, "", "index"], [1, 3, 1, "", "logout"], [1, 3, 1, "", "main"], [1, 3, 1, "", "session"], [1, 3, 1, "", "unauthorized"]], "pyninja.modules.exceptions": [[1, 4, 1, "", "APIResponse"], [1, 4, 1, "", "RedirectException"], [1, 4, 1, "", "SessionError"], [1, 4, 1, "", "UnSupportedOS"], [1, 1, 1, "", "raise_os_error"]], "pyninja.modules.models": [[1, 2, 1, "", "Architecture"], [1, 2, 1, "", "Database"], [1, 2, 1, "", "EnvConfig"], [1, 2, 1, "", "RateLimit"], [1, 2, 1, "", "ServiceStatus"], [1, 2, 1, "", "Session"], [1, 2, 1, "", "WSSession"], [1, 1, 1, "", "complexity_checker"], [1, 1, 1, "", "default_service_lib"], [1, 1, 1, "", "retrieve_library_path"]], "pyninja.modules.models.Architecture": [[1, 3, 1, "", "cpu"], [1, 3, 1, "", "disks"], [1, 3, 1, "", "gpu"]], "pyninja.modules.models.Database": [[1, 5, 1, "", "create_table"]], "pyninja.modules.models.EnvConfig": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "api_secret"], [1, 3, 1, "", "apikey"], [1, 3, 1, "", "database"], [1, 3, 1, "", "disk_lib"], [1, 3, 1, "", "disk_report"], [1, 5, 1, "", "from_env_file"], [1, 3, 1, "", "gpu_lib"], [1, 3, 1, "", "log_config"], [1, 3, 1, "", "max_connections"], [1, 3, 1, "", "monitor_password"], [1, 3, 1, "", "monitor_session"], [1, 3, 1, "", "monitor_username"], [1, 3, 1, "", "ninja_host"], [1, 3, 1, "", "ninja_port"], [1, 3, 1, "", "no_auth"], [1, 5, 1, "", "parse_api_secret"], [1, 5, 1, "", "parse_apikey"], [1, 3, 1, "", "processes"], [1, 3, 1, "", "processor_lib"], [1, 3, 1, "", "rate_limit"], [1, 3, 1, "", "remote_execution"], [1, 3, 1, "", "service_lib"], [1, 3, 1, "", "services"], [1, 3, 1, "", "smart_lib"]], "pyninja.modules.models.EnvConfig.Config": [[1, 3, 1, "", "extra"], [1, 3, 1, "", "hide_input_in_errors"]], "pyninja.modules.models.RateLimit": [[1, 3, 1, "", "max_requests"], [1, 3, 1, "", "seconds"]], "pyninja.modules.models.ServiceStatus": [[1, 3, 1, "", "description"], [1, 3, 1, "", "service_name"], [1, 3, 1, "", "status_code"]], "pyninja.modules.models.Session": [[1, 3, 1, "", "allowed_origins"], [1, 3, 1, "", "auth_counter"], [1, 3, 1, "", "forbid"], [1, 3, 1, "", "info"], [1, 3, 1, "", "rps"]], "pyninja.modules.models.WSSession": [[1, 3, 1, "", "client_auth"], [1, 3, 1, "", "invalid"]], "pyninja.modules.payloads": [[1, 2, 1, "", "GetFile"], [1, 2, 1, "", "ListFiles"], [1, 2, 1, "", "RunCommand"]], "pyninja.modules.payloads.GetFile": [[1, 3, 1, "", "filepath"]], "pyninja.modules.payloads.ListFiles": [[1, 3, 1, "", "deep_scan"], [1, 3, 1, "", "directory"], [1, 3, 1, "", "include_directories"], [1, 3, 1, "", "show_hidden_files"]], "pyninja.modules.payloads.RunCommand": [[1, 3, 1, "", "command"], [1, 3, 1, "", "timeout"]], "pyninja.modules.rate_limit": [[1, 2, 1, "", "RateLimiter"]], "pyninja.modules.rate_limit.RateLimiter": [[1, 5, 1, "", "init"]], "pyninja.modules.secure": [[1, 1, 1, "", "base64_decode"], [1, 1, 1, "", "base64_encode"], [1, 1, 1, "", "calculate_hash"], [1, 1, 1, "", "hex_decode"], [1, 1, 1, "", "hex_encode"]], "pyninja.monitor": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "drive"], [1, 0, 0, "-", "resources"], [1, 0, 0, "-", "routes"]], "pyninja.monitor.authenticator": [[1, 1, 1, "", "extract_credentials"], [1, 1, 1, "", "failed_auth_counter"], [1, 1, 1, "", "generate_cookie"], [1, 1, 1, "", "raise_error"], [1, 1, 1, "", "session_error"], [1, 1, 1, "", "validate_session"], [1, 1, 1, "", "verify_login"]], "pyninja.monitor.config": [[1, 1, 1, "", "clear_session"], [1, 1, 1, "", "get_expiry"]], "pyninja.monitor.drive": [[1, 1, 1, "", "invalidate"], [1, 1, 1, "", "report"]], "pyninja.monitor.resources": [[1, 1, 1, "", "container_cpu_limit"], [1, 1, 1, "", "containers"], [1, 1, 1, "", "get_cpu_percent"], [1, 1, 1, "", "get_disk_info"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_os_agnostic_metrics"], [1, 1, 1, "", "get_system_metrics"], [1, 1, 1, "", "landing_page"], [1, 1, 1, "", "map_docker_stats"], [1, 1, 1, "", "pyudisk_metrics"], [1, 1, 1, "", "system_resources"]], "pyninja.monitor.routes": [[1, 1, 1, "", "error_endpoint"], [1, 1, 1, "", "login_endpoint"], [1, 1, 1, "", "logout_endpoint"], [1, 1, 1, "", "monitor_endpoint"], [1, 1, 1, "", "websocket_endpoint"]], "pyninja.routes": [[1, 0, 0, "-", "fullaccess"], [1, 0, 0, "-", "ipaddr"], [1, 0, 0, "-", "metrics"], [1, 0, 0, "-", "namespace"], [1, 0, 0, "-", "orchestration"]], "pyninja.routes.fullaccess": [[1, 1, 1, "", "get_file"], [1, 1, 1, "", "list_files"], [1, 1, 1, "", "put_file"], [1, 1, 1, "", "run_command"]], "pyninja.routes.ipaddr": [[1, 1, 1, "", "get_ip_address"]], "pyninja.routes.metrics": [[1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_cpu_load_avg"], [1, 1, 1, "", "get_cpu_utilization"], [1, 1, 1, "", "get_disk_utilization"], [1, 1, 1, "", "get_memory_utilization"]], "pyninja.routes.namespace": [[1, 1, 1, "", "get_all_services"], [1, 1, 1, "", "get_process_status"], [1, 1, 1, "", "get_process_usage"], [1, 1, 1, "", "get_processor_name"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "get_service_usage"], [1, 1, 1, "", "start_service"], [1, 1, 1, "", "stop_service"]], "pyninja.routes.orchestration": [[1, 1, 1, "", "get_docker_containers"], [1, 1, 1, "", "get_docker_images"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_docker_volumes"], [1, 1, 1, "", "start_docker_container"], [1, 1, 1, "", "stop_docker_container"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:exception", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "method", "Python method"]}, "titleterms": {"pyninja": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "executor": 1, "api": 1, "authent": 1, "databas": 1, "rout": 1, "squir": 1, "featur": 1, "docker": 1, "oper": 1, "process": 1, "servic": 1, "modul": 1, "cach": 1, "enum": 1, "except": 1, "model": 1, "payload": 1, "ratelimit": 1, "secur": 1, "monitor": 1, "configur": 1, "drive": 1, "resourc": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
+Search.setIndex({"docnames": ["README", "index"], "filenames": ["README.md", "index.rst"], "titles": ["PyNinja", "Welcome to PyNinja\u2019s documentation!"], "terms": {"lightweight": 0, "o": [0, 1], "agnost": [0, 1], "servic": 0, "monitor": 0, "api": 0, "platform": 0, "support": [0, 1], "deploy": 0, "recommend": 0, "instal": [0, 1], "python": 0, "3": [0, 1], "10": [0, 1], "11": [0, 1], "us": [0, 1], "dedic": 0, "virtual": [0, 1], "m": 0, "pip": 0, "For": 0, "linux": [0, 1], "machin": [0, 1], "extra": [0, 1], "includ": [0, 1], "function": [0, 1], "from": [0, 1], "pyudisk": [0, 1], "": 0, "A": [0, 1], "r": 0, "t": [0, 1], "metric": [0, 1], "initi": 0, "id": [0, 1], "import": 0, "__name__": 0, "__main__": 0, "start": [0, 1], "cli": 0, "help": 0, "usag": [0, 1], "instruct": 0, "sourc": 0, "an": [0, 1], "env": [0, 1], "file": [0, 1], "By": 0, "default": [0, 1], "look": 0, "current": [0, 1], "work": [0, 1], "directori": [0, 1], "apikei": [0, 1], "kei": [0, 1], "authent": 0, "ninja": 0, "_": 0, "host": [0, 1], "hostnam": [0, 1], "server": [0, 1], "port": [0, 1], "number": [0, 1], "remot": [0, 1], "execut": [0, 1], "boolean": [0, 1], "flag": [0, 1], "enabl": [0, 1], "secret": [0, 1], "access": [0, 1], "run": [0, 1], "command": [0, 1], "disk": [0, 1], "report": [0, 1], "featur": 0, "udisk": 0, "lib": [0, 1], "librari": [0, 1], "usernam": [0, 1], "page": [0, 1], "password": [0, 1], "session": [0, 1], "timeout": [0, 1], "NO": 0, "auth": [0, 1], "without": 0, "max": [0, 1], "connect": [0, 1], "maximum": [0, 1], "allow": [0, 1], "parallel": 0, "process": 0, "list": [0, 1], "name": [0, 1], "gpu": [0, 1], "filepath": [0, 1], "memori": [0, 1], "processor": [0, 1], "databas": 0, "store": [0, 1], "handl": [0, 1], "error": [0, 1], "rate": [0, 1], "limit": [0, 1], "dictionari": [0, 1], "max_request": [0, 1], "second": [0, 1], "appli": [0, 1], "log": [0, 1], "config": [0, 1], "configur": 0, "path": [0, 1], "can": [0, 1], "extrem": 0, "riski": 0, "major": 0, "secur": 0, "threat": 0, "so": [0, 1], "caution": 0, "set": [0, 1], "strong": [0, 1], "valu": [0, 1], "refer": [0, 1], "sampl": 0, "exampl": [0, 1], "docstr": 0, "format": [0, 1], "googl": 0, "style": 0, "convent": 0, "pep": 0, "8": 0, "isort": 0, "requir": [0, 1], "gitvers": 0, "revers": 0, "f": 0, "release_not": 0, "rst": 0, "pre": 0, "commit": 0, "ensur": [0, 1], "pytest": 0, "gener": [0, 1], "valid": [0, 1], "hyperlink": [0, 1], "all": [0, 1], "markdown": 0, "wiki": 0, "sphinx": 0, "5": [0, 1], "1": [0, 1], "recommonmark": 0, "http": [0, 1], "org": 0, "project": 0, "thevickypedia": 0, "github": 0, "io": 0, "vignesh": 0, "rao": 0, "under": 0, "mit": 0, "kick": 1, "off": 1, "environ": 1, "variabl": 1, "code": 1, "standard": 1, "releas": 1, "note": 1, "lint": 1, "pypi": 1, "packag": 1, "runbook": 1, "licens": 1, "copyright": 1, "generate_hyperlink": 1, "fastapi": 1, "apirout": 1, "apiwebsocketrout": 1, "str": 1, "particular": 1, "get_desc": 1, "get_rout": 1, "routinghandl": 1, "post_rout": 1, "monitor_rout": 1, "construct": 1, "detail": 1, "descript": 1, "doc": 1, "paramet": 1, "object": 1, "get": 1, "endpoint": 1, "post": 1, "return": 1, "string": 1, "type": 1, "async": 1, "redirect_exception_handl": 1, "request": 1, "redirectexcept": 1, "jsonrespons": 1, "custom": 1, "handler": 1, "redirect": 1, "take": 1, "argument": 1, "inherit": 1, "statu": 1, "cooki": 1, "kwarg": 1, "none": 1, "starter": 1, "which": 1, "uvicorn": 1, "trigger": 1, "keyword": 1, "env_fil": 1, "load": 1, "ninja_host": 1, "ninja_port": 1, "remote_execut": 1, "api_secret": 1, "monitor_usernam": 1, "monitor_password": 1, "monitor_sess": 1, "service_manag": 1, "manag": 1, "rate_limit": 1, "log_config": 1, "dict": 1, "yaml": 1, "yml": 1, "json": 1, "ini": 1, "epoch": 1, "forbidden": 1, "i": 1, "part": 1, "rais": 1, "apirespons": 1, "403": 1, "If": 1, "address": 1, "level_1": 1, "httpauthorizationcredenti": 1, "httpbearer": 1, "author": 1, "header": 1, "token": 1, "basic": 1, "401": 1, "invalid": 1, "level_2": 1, "addition": 1, "addit": 1, "critic": 1, "increment": 1, "attempt": 1, "int": 1, "block": 1, "time": 1, "base": 1, "fail": 1, "login": 1, "appropri": 1, "minut": 1, "handle_auth_error": 1, "filebrows": 1, "The": 1, "incom": 1, "get_record": 1, "until": 1, "when": 1, "should": 1, "put_record": 1, "block_until": 1, "insert": 1, "remove_record": 1, "delet": 1, "record": 1, "relat": 1, "fullaccess": 1, "run_command": 1, "runcommand": 1, "depend": 1, "option": 1, "arg": 1, "receiv": 1, "bodi": 1, "httpstatu": 1, "respons": 1, "list_fil": 1, "listfil": 1, "fileio": 1, "download": 1, "upload": 1, "get_fil": 1, "getfil": 1, "filerespons": 1, "put_fil": 1, "uploadfil": 1, "overwrit": 1, "bool": 1, "fals": 1, "th": 1, "param": 1, "ipaddr": 1, "get_ip_address": 1, "public": 1, "local": 1, "ip": 1, "devic": 1, "privat": 1, "get_cpu_util": 1, "interv": 1, "float": 1, "2": 1, "per_cpu": 1, "true": 1, "cpu": 1, "util": 1, "each": 1, "get_memory_util": 1, "get_cpu_load_avg": 1, "system": 1, "queue": 1, "averag": 1, "over": 1, "last": 1, "15": 1, "respect": 1, "get_disk_util": 1, "get_all_disk": 1, "attach": 1, "namespac": 1, "get_process_statu": 1, "process_nam": 1, "cpu_interv": 1, "union": 1, "check": 1, "get_service_usag": 1, "service_nam": 1, "comma": 1, "separ": 1, "get_process_usag": 1, "get_all_servic": 1, "get_service_statu": 1, "stop_servic": 1, "stop": 1, "start_servic": 1, "get_processor_nam": 1, "inform": 1, "orchestr": 1, "get_docker_contain": 1, "container_nam": 1, "get_al": 1, "get_run": 1, "contain": 1, "stop_docker_contain": 1, "start_docker_contain": 1, "get_docker_imag": 1, "imag": 1, "get_docker_volum": 1, "volum": 1, "get_docker_stat": 1, "stat": 1, "router": 1, "monitor_redirect": 1, "redirectrespons": 1, "user": 1, "docs_redirect": 1, "health": 1, "200": 1, "get_api": 1, "ad": 1, "post_api": 1, "monitoring_ui": 1, "applic": 1, "inject": 1, "websocket": 1, "public_ip_address": 1, "differ": 1, "private_ip_address": 1, "simpl": 1, "network": 1, "see": 1, "format_no": 1, "input_": 1, "remov": 1, "0": 1, "integ": 1, "end": 1, "found": 1, "els": 1, "format_timedelta": 1, "td": 1, "timedelta": 1, "convert": 1, "human": 1, "readabl": 1, "non": 1, "zero": 1, "alwai": 1, "output": 1, "two": 1, "identifi": 1, "dai": 1, "hour": 1, "23": 1, "size_convert": 1, "byte_s": 1, "consum": 1, "friendli": 1, "byte": 1, "size": 1, "process_command": 1, "result": 1, "stdout": 1, "stderr": 1, "pair": 1, "envfile_load": 1, "filenam": 1, "pathlik": 1, "envconfig": 1, "filetyp": 1, "where": 1, "var": 1, "have": 1, "load_env": 1, "merg": 1, "give": 1, "prioriti": 1, "thi": 1, "partial": 1, "through": 1, "load_architectur": 1, "architectur": 1, "keygen": 1, "ar": 1, "forc": 1, "restart": 1, "url": 1, "safe": 1, "64": 1, "bit": 1, "dynamic_numb": 1, "dynam": 1, "assert_pyudisk": 1, "disk_report": 1, "onli": 1, "udiskctl": 1, "assert_token": 1, "least": 1, "ani": 1, "handle_warn": 1, "warn": 1, "comma_separ": 1, "list_": 1, "join": 1, "input": 1, "length": 1, "element": 1, "convert_second": 1, "n_elem": 1, "calcul": 1, "year": 1, "month": 1, "given": 1, "notion": 1, "humanize_usage_metr": 1, "total_mountpoints_usag": 1, "mountpoint": 1, "as_byt": 1, "sum": 1, "up": 1, "locat": 1, "get_container_statu": 1, "get_running_contain": 1, "yield": 1, "correspond": 1, "get_all_contain": 1, "get_all_imag": 1, "get_all_volum": 1, "stop_contain": 1, "start_contain": 1, "get_process_info": 1, "proc": 1, "psutil": 1, "statist": 1, "process_monitor": 1, "case": 1, "sensit": 1, "thei": 1, "strictli": 1, "match": 1, "maco": 1, "top": 1, "grep": 1, "window": 1, "task": 1, "service_monitor": 1, "follow": 1, "right": 1, "launchctl": 1, "systemctl": 1, "show": 1, "properti": 1, "mainpid": 1, "sc": 1, "queri": 1, "get_service_pid": 1, "retriev": 1, "pid": 1, "get_service_pid_linux": 1, "get_service_pid_maco": 1, "get_service_pid_window": 1, "perform": 1, "get_perform": 1, "thread": 1, "open": 1, "servicestatu": 1, "501": 1, "unknown": 1, "503": 1, "unavail": 1, "404": 1, "get_process_object": 1, "creat": 1, "avail": 1, "instanc": 1, "timed_cach": 1, "max_ag": 1, "maxsiz": 1, "128": 1, "recent": 1, "decor": 1, "live": 1, "functool": 1, "lru_cach": 1, "distinct": 1, "even": 1, "one": 1, "chang": 1, "map": 1, "new": 1, "entri": 1, "thu": 1, "refresh": 1, "just": 1, "trick": 1, "provid": 1, "ttl": 1, "monoton": 1, "sinc": 1, "reli": 1, "clock": 1, "mai": 1, "guarante": 1, "increas": 1, "fact": 1, "decreas": 1, "sync": 1, "its": 1, "class": 1, "operatingsystem": 1, "qualnam": 1, "boundari": 1, "darwin": 1, "apiendpoint": 1, "root": 1, "redoc": 1, "put": 1, "get_processor": 1, "ws_system": 1, "w": 1, "get_memori": 1, "get_ip": 1, "get_cpu": 1, "get_cpu_load": 1, "logout": 1, "session_token": 1, "templat": 1, "html": 1, "index": 1, "unauthor": 1, "disk_report_linux": 1, "disk_report_darwin": 1, "apiroutetyp": 1, "status_cod": 1, "httpexcept": 1, "wrap": 1, "unsupportedo": 1, "unsupport": 1, "within": 1, "doesn": 1, "demand": 1, "solut": 1, "There": 1, "altern": 1, "our": 1, "javascript": 1, "wai": 1, "come": 1, "handi": 1, "mani": 1, "unexpect": 1, "scenario": 1, "tiangolo": 1, "com": 1, "tutori": 1, "sessionerror": 1, "raise_os_error": 1, "operating_system": 1, "noreturn": 1, "validationerror": 1, "overridden": 1, "pydant": 1, "basemodel": 1, "updat": 1, "arbitrary_types_allow": 1, "auth_count": 1, "forbid": 1, "info": 1, "rp": 1, "allowed_origin": 1, "wssession": 1, "client_auth": 1, "smart_lib": 1, "max_connect": 1, "no_auth": 1, "gpu_lib": 1, "disk_lib": 1, "service_lib": 1, "processor_lib": 1, "classmethod": 1, "parse_apikei": 1, "pars": 1, "complex": 1, "parse_api_secret": 1, "from_env_fil": 1, "ignor": 1, "hide_input_in_error": 1, "complexity_check": 1, "min_length": 1, "verifi": 1, "strength": 1, "consid": 1, "ha": 1, "32": 1, "charact": 1, "digit": 1, "symbol": 1, "uppercas": 1, "letter": 1, "lowercas": 1, "assertionerror": 1, "abov": 1, "condit": 1, "default_service_lib": 1, "referenc": 1, "retrieve_library_path": 1, "func": 1, "callabl": 1, "call": 1, "datastor": 1, "sqlite3": 1, "create_t": 1, "table_nam": 1, "column": 1, "tupl": 1, "show_hidden_fil": 1, "include_directori": 1, "deep_scan": 1, "implement": 1, "init": 1, "exce": 1, "429": 1, "too": 1, "calculate_hash": 1, "hash": 1, "base64_encod": 1, "base64": 1, "encod": 1, "base64_decod": 1, "decod": 1, "hex_decod": 1, "hex": 1, "hex_encod": 1, "failed_auth_count": 1, "keep": 1, "track": 1, "more": 1, "raise_error": 1, "bad": 1, "credenti": 1, "extract_credenti": 1, "extract": 1, "befor": 1, "verify_login": 1, "generate_cooki": 1, "auth_payload": 1, "timestamp": 1, "session_error": 1, "htmlrespons": 1, "render": 1, "messag": 1, "jinja2": 1, "validate_sess": 1, "cookie_str": 1, "summari": 1, "clear_sess": 1, "clear": 1, "get_expiri": 1, "lease_start": 1, "lease_dur": 1, "expiri": 1, "datetim": 1, "ag": 1, "wa": 1, "made": 1, "date": 1, "gmt": 1, "ctx": 1, "500": 1, "after": 1, "context": 1, "enter": 1, "landing_pag": 1, "land": 1, "jinja": 1, "get_disk_info": 1, "partit": 1, "physic": 1, "container_cpu_limit": 1, "core": 1, "nanocpu": 1, "map_docker_stat": 1, "json_data": 1, "data": 1, "get_cpu_perc": 1, "percentag": 1, "asynchron": 1, "get_system_metr": 1, "swap": 1, "nest": 1, "get_os_agnostic_metr": 1, "pyudisk_metr": 1, "mean": 1, "60": 1, "avoid": 1, "gather": 1, "everi": 1, "improv": 1, "latenc": 1, "overhead": 1, "system_resourc": 1, "error_endpoint": 1, "logout_endpoint": 1, "out": 1, "login_endpoint": 1, "redirect_url": 1, "monitor_endpoint": 1, "ui": 1, "websocket_endpoint": 1, "fetch": 1, "search": 1}, "objects": {"pyninja.executors": [[1, 0, 0, "-", "auth"], [1, 0, 0, "-", "database"], [1, 0, 0, "-", "routers"], [1, 0, 0, "-", "squire"]], "pyninja.executors.auth": [[1, 1, 1, "", "EPOCH"], [1, 1, 1, "", "forbidden"], [1, 1, 1, "", "handle_auth_error"], [1, 1, 1, "", "incrementer"], [1, 1, 1, "", "level_1"], [1, 1, 1, "", "level_2"]], "pyninja.executors.database": [[1, 1, 1, "", "get_record"], [1, 1, 1, "", "put_record"], [1, 1, 1, "", "remove_record"]], "pyninja.executors.routers": [[1, 1, 1, "", "docs_redirect"], [1, 1, 1, "", "get_api"], [1, 1, 1, "", "health"], [1, 1, 1, "", "monitor_redirect"], [1, 1, 1, "", "monitoring_ui"], [1, 1, 1, "", "post_api"]], "pyninja.executors.squire": [[1, 1, 1, "", "assert_pyudisk"], [1, 1, 1, "", "assert_tokens"], [1, 1, 1, "", "comma_separator"], [1, 1, 1, "", "convert_seconds"], [1, 1, 1, "", "dynamic_numbers"], [1, 1, 1, "", "envfile_loader"], [1, 1, 1, "", "format_nos"], [1, 1, 1, "", "format_timedelta"], [1, 1, 1, "", "handle_warnings"], [1, 1, 1, "", "humanize_usage_metrics"], [1, 1, 1, "", "keygen"], [1, 1, 1, "", "load_architecture"], [1, 1, 1, "", "load_env"], [1, 1, 1, "", "private_ip_address"], [1, 1, 1, "", "process_command"], [1, 1, 1, "", "public_ip_address"], [1, 1, 1, "", "size_converter"], [1, 1, 1, "", "total_mountpoints_usage"]], "pyninja.features": [[1, 0, 0, "-", "dockerized"], [1, 0, 0, "-", "operations"], [1, 0, 0, "-", "process"], [1, 0, 0, "-", "service"]], "pyninja.features.dockerized": [[1, 1, 1, "", "get_all_containers"], [1, 1, 1, "", "get_all_images"], [1, 1, 1, "", "get_all_volumes"], [1, 1, 1, "", "get_container_status"], [1, 1, 1, "", "get_running_containers"], [1, 1, 1, "", "start_container"], [1, 1, 1, "", "stop_container"]], "pyninja.features.operations": [[1, 1, 1, "", "default"], [1, 1, 1, "", "get_process_info"], [1, 1, 1, "", "get_service_pid"], [1, 1, 1, "", "get_service_pid_linux"], [1, 1, 1, "", "get_service_pid_macos"], [1, 1, 1, "", "get_service_pid_windows"], [1, 1, 1, "", "process_monitor"], [1, 1, 1, "", "service_monitor"]], "pyninja.features.process": [[1, 1, 1, "", "get_performance"], [1, 1, 1, "", "get_process_status"]], "pyninja.features.service": [[1, 1, 1, "", "get_all_services"], [1, 1, 1, "", "get_process_object"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "running"], [1, 1, 1, "", "start_service"], [1, 1, 1, "", "stop_service"], [1, 1, 1, "", "stopped"], [1, 1, 1, "", "unavailable"], [1, 1, 1, "", "unknown"]], "pyninja": [[1, 0, 0, "-", "main"]], "pyninja.main": [[1, 1, 1, "", "generate_hyperlink"], [1, 1, 1, "", "get_desc"], [1, 1, 1, "", "redirect_exception_handler"], [1, 1, 1, "", "start"]], "pyninja.modules": [[1, 0, 0, "-", "cache"], [1, 0, 0, "-", "enums"], [1, 0, 0, "-", "exceptions"], [1, 0, 0, "-", "models"], [1, 0, 0, "-", "rate_limit"], [1, 0, 0, "-", "secure"]], "pyninja.modules.cache": [[1, 1, 1, "", "timed_cache"]], "pyninja.modules.enums": [[1, 2, 1, "", "APIEndpoints"], [1, 2, 1, "", "APIRouteType"], [1, 2, 1, "", "Cookies"], [1, 2, 1, "", "OperatingSystem"], [1, 2, 1, "", "Templates"]], "pyninja.modules.enums.APIEndpoints": [[1, 3, 1, "", "docs"], [1, 3, 1, "", "error"], [1, 3, 1, "", "get_all_disks"], [1, 3, 1, "", "get_all_services"], [1, 3, 1, "", "get_cpu"], [1, 3, 1, "", "get_cpu_load"], [1, 3, 1, "", "get_disk_utilization"], [1, 3, 1, "", "get_docker_containers"], [1, 3, 1, "", "get_docker_images"], [1, 3, 1, "", "get_docker_stats"], [1, 3, 1, "", "get_docker_volumes"], [1, 3, 1, "", "get_file"], [1, 3, 1, "", "get_ip"], [1, 3, 1, "", "get_memory"], [1, 3, 1, "", "get_process_status"], [1, 3, 1, "", "get_process_usage"], [1, 3, 1, "", "get_processor"], [1, 3, 1, "", "get_service_status"], [1, 3, 1, "", "get_service_usage"], [1, 3, 1, "", "health"], [1, 3, 1, "", "list_files"], [1, 3, 1, "", "login"], [1, 3, 1, "", "logout"], [1, 3, 1, "", "monitor"], [1, 3, 1, "", "put_file"], [1, 3, 1, "", "redoc"], [1, 3, 1, "", "root"], [1, 3, 1, "", "run_command"], [1, 3, 1, "", "start_docker_container"], [1, 3, 1, "", "start_service"], [1, 3, 1, "", "stop_docker_container"], [1, 3, 1, "", "stop_service"], [1, 3, 1, "", "ws_system"]], "pyninja.modules.enums.APIRouteType": [[1, 3, 1, "", "get"], [1, 3, 1, "", "monitor"], [1, 3, 1, "", "post"]], "pyninja.modules.enums.Cookies": [[1, 3, 1, "", "drive"], [1, 3, 1, "", "monitor"], [1, 3, 1, "", "session_token"]], "pyninja.modules.enums.OperatingSystem": [[1, 3, 1, "", "darwin"], [1, 3, 1, "", "linux"], [1, 3, 1, "", "windows"]], "pyninja.modules.enums.Templates": [[1, 3, 1, "", "disk_report_darwin"], [1, 3, 1, "", "disk_report_linux"], [1, 3, 1, "", "index"], [1, 3, 1, "", "logout"], [1, 3, 1, "", "main"], [1, 3, 1, "", "session"], [1, 3, 1, "", "unauthorized"]], "pyninja.modules.exceptions": [[1, 4, 1, "", "APIResponse"], [1, 4, 1, "", "RedirectException"], [1, 4, 1, "", "SessionError"], [1, 4, 1, "", "UnSupportedOS"], [1, 1, 1, "", "raise_os_error"]], "pyninja.modules.models": [[1, 2, 1, "", "Architecture"], [1, 2, 1, "", "Database"], [1, 2, 1, "", "EnvConfig"], [1, 2, 1, "", "RateLimit"], [1, 2, 1, "", "RoutingHandler"], [1, 2, 1, "", "ServiceStatus"], [1, 2, 1, "", "Session"], [1, 2, 1, "", "WSSession"], [1, 1, 1, "", "complexity_checker"], [1, 1, 1, "", "default_service_lib"], [1, 1, 1, "", "retrieve_library_path"]], "pyninja.modules.models.Architecture": [[1, 3, 1, "", "cpu"], [1, 3, 1, "", "disks"], [1, 3, 1, "", "gpu"]], "pyninja.modules.models.Database": [[1, 5, 1, "", "create_table"]], "pyninja.modules.models.EnvConfig": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "api_secret"], [1, 3, 1, "", "apikey"], [1, 3, 1, "", "database"], [1, 3, 1, "", "disk_lib"], [1, 3, 1, "", "disk_report"], [1, 5, 1, "", "from_env_file"], [1, 3, 1, "", "gpu_lib"], [1, 3, 1, "", "log_config"], [1, 3, 1, "", "max_connections"], [1, 3, 1, "", "monitor_password"], [1, 3, 1, "", "monitor_session"], [1, 3, 1, "", "monitor_username"], [1, 3, 1, "", "ninja_host"], [1, 3, 1, "", "ninja_port"], [1, 3, 1, "", "no_auth"], [1, 5, 1, "", "parse_api_secret"], [1, 5, 1, "", "parse_apikey"], [1, 3, 1, "", "processes"], [1, 3, 1, "", "processor_lib"], [1, 3, 1, "", "rate_limit"], [1, 3, 1, "", "remote_execution"], [1, 3, 1, "", "service_lib"], [1, 3, 1, "", "services"], [1, 3, 1, "", "smart_lib"]], "pyninja.modules.models.EnvConfig.Config": [[1, 3, 1, "", "extra"], [1, 3, 1, "", "hide_input_in_errors"]], "pyninja.modules.models.RateLimit": [[1, 3, 1, "", "max_requests"], [1, 3, 1, "", "seconds"]], "pyninja.modules.models.RoutingHandler": [[1, 2, 1, "", "Config"], [1, 3, 1, "", "enabled"], [1, 3, 1, "", "routes"], [1, 3, 1, "", "type"]], "pyninja.modules.models.RoutingHandler.Config": [[1, 3, 1, "", "arbitrary_types_allowed"]], "pyninja.modules.models.ServiceStatus": [[1, 3, 1, "", "description"], [1, 3, 1, "", "service_name"], [1, 3, 1, "", "status_code"]], "pyninja.modules.models.Session": [[1, 3, 1, "", "allowed_origins"], [1, 3, 1, "", "auth_counter"], [1, 3, 1, "", "forbid"], [1, 3, 1, "", "info"], [1, 3, 1, "", "rps"]], "pyninja.modules.models.WSSession": [[1, 3, 1, "", "client_auth"], [1, 3, 1, "", "invalid"]], "pyninja.modules.payloads": [[1, 2, 1, "", "GetFile"], [1, 2, 1, "", "ListFiles"], [1, 2, 1, "", "RunCommand"]], "pyninja.modules.payloads.GetFile": [[1, 3, 1, "", "filepath"]], "pyninja.modules.payloads.ListFiles": [[1, 3, 1, "", "deep_scan"], [1, 3, 1, "", "directory"], [1, 3, 1, "", "include_directories"], [1, 3, 1, "", "show_hidden_files"]], "pyninja.modules.payloads.RunCommand": [[1, 3, 1, "", "command"], [1, 3, 1, "", "timeout"]], "pyninja.modules.rate_limit": [[1, 2, 1, "", "RateLimiter"]], "pyninja.modules.rate_limit.RateLimiter": [[1, 5, 1, "", "init"]], "pyninja.modules.secure": [[1, 1, 1, "", "base64_decode"], [1, 1, 1, "", "base64_encode"], [1, 1, 1, "", "calculate_hash"], [1, 1, 1, "", "hex_decode"], [1, 1, 1, "", "hex_encode"]], "pyninja.monitor": [[1, 0, 0, "-", "authenticator"], [1, 0, 0, "-", "config"], [1, 0, 0, "-", "drive"], [1, 0, 0, "-", "resources"], [1, 0, 0, "-", "routes"]], "pyninja.monitor.authenticator": [[1, 1, 1, "", "extract_credentials"], [1, 1, 1, "", "failed_auth_counter"], [1, 1, 1, "", "generate_cookie"], [1, 1, 1, "", "raise_error"], [1, 1, 1, "", "session_error"], [1, 1, 1, "", "validate_session"], [1, 1, 1, "", "verify_login"]], "pyninja.monitor.config": [[1, 1, 1, "", "clear_session"], [1, 1, 1, "", "get_expiry"]], "pyninja.monitor.drive": [[1, 1, 1, "", "invalidate"], [1, 1, 1, "", "report"]], "pyninja.monitor.resources": [[1, 1, 1, "", "container_cpu_limit"], [1, 1, 1, "", "containers"], [1, 1, 1, "", "get_cpu_percent"], [1, 1, 1, "", "get_disk_info"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_os_agnostic_metrics"], [1, 1, 1, "", "get_system_metrics"], [1, 1, 1, "", "landing_page"], [1, 1, 1, "", "map_docker_stats"], [1, 1, 1, "", "pyudisk_metrics"], [1, 1, 1, "", "system_resources"]], "pyninja.monitor.routes": [[1, 1, 1, "", "error_endpoint"], [1, 1, 1, "", "login_endpoint"], [1, 1, 1, "", "logout_endpoint"], [1, 1, 1, "", "monitor_endpoint"], [1, 1, 1, "", "websocket_endpoint"]], "pyninja.routes": [[1, 0, 0, "-", "fullaccess"], [1, 0, 0, "-", "ipaddr"], [1, 0, 0, "-", "metrics"], [1, 0, 0, "-", "namespace"], [1, 0, 0, "-", "orchestration"]], "pyninja.routes.fullaccess": [[1, 1, 1, "", "get_file"], [1, 1, 1, "", "list_files"], [1, 1, 1, "", "put_file"], [1, 1, 1, "", "run_command"]], "pyninja.routes.ipaddr": [[1, 1, 1, "", "get_ip_address"]], "pyninja.routes.metrics": [[1, 1, 1, "", "get_all_disks"], [1, 1, 1, "", "get_cpu_load_avg"], [1, 1, 1, "", "get_cpu_utilization"], [1, 1, 1, "", "get_disk_utilization"], [1, 1, 1, "", "get_memory_utilization"]], "pyninja.routes.namespace": [[1, 1, 1, "", "get_all_services"], [1, 1, 1, "", "get_process_status"], [1, 1, 1, "", "get_process_usage"], [1, 1, 1, "", "get_processor_name"], [1, 1, 1, "", "get_service_status"], [1, 1, 1, "", "get_service_usage"], [1, 1, 1, "", "start_service"], [1, 1, 1, "", "stop_service"]], "pyninja.routes.orchestration": [[1, 1, 1, "", "get_docker_containers"], [1, 1, 1, "", "get_docker_images"], [1, 1, 1, "", "get_docker_stats"], [1, 1, 1, "", "get_docker_volumes"], [1, 1, 1, "", "start_docker_container"], [1, 1, 1, "", "stop_docker_container"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:attribute", "4": "py:exception", "5": "py:method"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "method", "Python method"]}, "titleterms": {"pyninja": [0, 1], "kick": 0, "off": 0, "environ": 0, "variabl": 0, "code": 0, "standard": 0, "releas": 0, "note": 0, "lint": 0, "pypi": 0, "packag": 0, "runbook": 0, "licens": 0, "copyright": 0, "welcom": 1, "": 1, "document": 1, "content": 1, "main": 1, "executor": 1, "api": 1, "authent": 1, "databas": 1, "rout": 1, "squir": 1, "featur": 1, "docker": 1, "oper": 1, "process": 1, "servic": 1, "modul": 1, "cach": 1, "enum": 1, "except": 1, "model": 1, "payload": 1, "ratelimit": 1, "secur": 1, "monitor": 1, "configur": 1, "drive": 1, "resourc": 1, "indic": 1, "tabl": 1}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}})
\ No newline at end of file
diff --git a/pyninja/executors/routers.py b/pyninja/executors/routers.py
index 89c8109..f82abc1 100644
--- a/pyninja/executors/routers.py
+++ b/pyninja/executors/routers.py
@@ -94,7 +94,7 @@ def get_api(dependencies: List[Depends]) -> List[APIRoute]:
             dependencies=dependencies,
         ),
         APIRoute(
-            path=enums.APIEndpoints.get_disk,
+            path=enums.APIEndpoints.get_disk_utilization,
             endpoint=metrics.get_disk_utilization,
             methods=["GET"],
             dependencies=dependencies,
diff --git a/pyninja/main.py b/pyninja/main.py
index 30de279..142da30 100644
--- a/pyninja/main.py
+++ b/pyninja/main.py
@@ -4,7 +4,7 @@
 import uvicorn
 from fastapi import Depends, FastAPI, Request
 from fastapi.responses import JSONResponse, RedirectResponse
-from fastapi.routing import APIRoute
+from fastapi.routing import APIRoute, APIWebSocketRoute
 
 from pyninja import version
 from pyninja.executors import routers, squire
@@ -30,26 +30,39 @@
 )
 
 
-def get_desc(get_api: bool, post_api: bool, monitoring_ui: bool) -> str:
+def generate_hyperlink(route: APIRoute | APIWebSocketRoute) -> str:
+    """Generates hyperlink for a particular API route."""
+    method = list(route.methods)[0].lower()
+    route_path = route.path.lstrip("/").replace("-", "_")
+    return f"\n- <a href='/docs#/default/{route.name}_{route_path}_{method}'>{route.path}</a><br>"
+
+
+def get_desc(
+    get_routes: models.RoutingHandler,
+    post_routes: models.RoutingHandler,
+    monitor_routes: models.RoutingHandler,
+) -> str:
     """Construct a detailed description for the API docs.
 
     Args:
-        get_api: Boolean flag to indicate basic API state.
-        post_api: Boolean flag to indicate remote execution state.
-        monitoring_ui: Boolean flag to indicate monitoring page state.
+        get_routes: RoutingHandler object for GET endpoints.
+        post_routes: RoutingHandler object for POST endpoints.
+        monitor_routes: RoutingHandler object for MONITOR endpoints.
 
     Returns:
         str:
         Returns the description as a string.
     """
-    # todo: Remove hard coding and update this programmatically based on available endpoints
     basic_fl, remote_fl, monitor_fl = ("Disabled",) * 3
-    if get_api:
+    if get_routes.enabled:
         basic_fl = "All basic GET calls have been enabled"
-    if post_api:
-        remote_fl = "Enabled at <a href='/docs#/default/run_command_run_command_post'>/run-command</a>"
-    if monitoring_ui:
-        monitor_fl = "Enabled at <a href='/monitor'>/monitor</a>"
+    if post_routes.enabled:
+        n = enums.APIEndpoints.run_command.name
+        v = enums.APIEndpoints.run_command.value
+        remote_fl = f"Enabled at <a href='/docs#/default/{n}_{n}_post'>{v}</a>"
+    if monitor_routes.enabled:
+        v = enums.APIEndpoints.monitor.value
+        monitor_fl = f"Enabled at <a href='{v}'>{v}</a>"
     description = "**Lightweight OS-agnostic service monitoring API**"
     description += (
         "\n\nIn addition to monitoring services, processes, and containers,"
@@ -57,22 +70,16 @@ def get_desc(get_api: bool, post_api: bool, monitoring_ui: bool) -> str:
         "and hosting a real-time system resource monitoring page. 🚀"
     )
     description += "\n\n#### Basic Features"
-    description += "\n- <a href='/docs#/default/get_ip_get_ip_get'>/get-ip</a><br>"
-    description += "\n- <a href='/docs#/default/get_cpu_get_cpu_get'>/get-cpu</a><br>"
+    for route in get_routes.routes:
+        description += generate_hyperlink(route)
+    description += "\n\n#### Additional Features**"
+    for route in post_routes.routes:
+        description += generate_hyperlink(route)
+    for route in monitor_routes.routes:
+        if route.path == enums.APIEndpoints.monitor:
+            description += generate_hyperlink(route)
     description += (
-        "\n- <a href='/docs#/default/get_memory_get_memory_get'>/get-memory</a><br>"
-    )
-    description += "\n- <a href='/docs#/default/service_status_service_status_get'>/service-status</a><br>"
-    description += "\n- <a href='/docs#/default/process_status_process_status_get'>/process-status</a><br>"
-    description += "\n- <a href='/docs#/default/docker_containers_docker_container_get'>/docker-container</a><br>"
-    description += "\n- <a href='/docs#/default/docker_images_docker_image_get'>/docker-image</a><br>"
-    description += "\n- <a href='/docs#/default/docker_volumes_docker_volume_get'>/docker-volume</a><br>"
-    description += "\n\n#### Additional Features"
-    description += (
-        "\n- <a href='/docs#/default/run_command_run_command_post'>/run-command</a><br>"
-    )
-    description += (
-        "\n- <a href='/docs#/default/monitor_endpoint_monitor_get'>/monitor</a><br>"
+        "\n> **Additional features are available based on server configuration."
     )
     description += "\n\n#### Current State"
     description += f"\n- **Basic Execution:** {basic_fl}"
@@ -144,7 +151,15 @@ def start(**kwargs) -> None:
         Depends(dependency=rate_limit.RateLimiter(each_rate_limit).init)
         for each_rate_limit in models.env.rate_limit
     ]
-    arg1, arg2, arg3 = False, False, False
+    get_routes = models.RoutingHandler(
+        type=enums.APIRouteType.get, routes=routers.get_api(dependencies)
+    )
+    post_routes = models.RoutingHandler(
+        type=enums.APIRouteType.post, routes=routers.post_api(dependencies)
+    )
+    monitor_routes = models.RoutingHandler(
+        type=enums.APIRouteType.monitor, routes=routers.monitoring_ui(dependencies)
+    )
 
     # Conditional endpoints based on 'apikey' value
     if models.env.apikey:
@@ -157,8 +172,8 @@ def start(**kwargs) -> None:
                 include_in_schema=False,
             ),
         )
-        PyNinjaAPI.routes.extend(routers.get_api(dependencies))
-        arg1 = True
+        PyNinjaAPI.routes.extend(get_routes.routes)
+        get_routes.enabled = True
     else:
         BASE_LOGGER.warning("Basic API functionality disabled")
 
@@ -169,14 +184,15 @@ def start(**kwargs) -> None:
         )
         models.database = models.Database(models.env.database)
         models.database.create_table("auth_errors", ["host", "block_until"])
-        PyNinjaAPI.routes.extend(routers.post_api(dependencies))
-        arg2 = True
+        PyNinjaAPI.routes.extend(post_routes.routes)
+        post_routes.enabled = True
     else:
         BASE_LOGGER.warning("Remote execution disabled")
 
     # Conditional endpoints based on 'monitor_username' and 'monitor_password' values
     if all((models.env.monitor_username, models.env.monitor_password)):
-        PyNinjaAPI.routes.extend(routers.monitoring_ui(dependencies))
+        PyNinjaAPI.routes.extend(monitor_routes.routes)
+        monitor_routes.enabled = True
         PyNinjaAPI.add_exception_handler(
             exc_class_or_status_code=exceptions.RedirectException,
             handler=redirect_exception_handler,  # noqa: PyTypeChecker
@@ -191,11 +207,10 @@ def start(**kwargs) -> None:
                     include_in_schema=False,
                 ),
             )
-        arg3 = True
     else:
         BASE_LOGGER.warning("Monitoring feature disabled")
 
-    PyNinjaAPI.description = get_desc(arg1, arg2, arg3)
+    PyNinjaAPI.description = get_desc(get_routes, post_routes, monitor_routes)
     module_name = pathlib.Path(__file__)
     kwargs = dict(
         host=models.env.ninja_host,
diff --git a/pyninja/modules/enums.py b/pyninja/modules/enums.py
index 8b21ad5..90a33c9 100644
--- a/pyninja/modules/enums.py
+++ b/pyninja/modules/enums.py
@@ -49,9 +49,9 @@ class APIEndpoints(StrEnum):
     ws_system: str = "/ws/system"
     run_command: str = "/run-command"
 
-    get_disk: str = "/get-disk"
     get_memory: str = "/get-memory"
     get_all_disks: str = "/get-all-disks"
+    get_disk_utilization: str = "/get-disk-utilization"
 
     get_docker_images: str = "/get-docker-images"
     get_docker_stats: str = "/get-docker-stats"
@@ -97,3 +97,15 @@ class Templates(StrEnum):
     unauthorized: str = "unauthorized.html"
     disk_report_linux: str = "disk_report_linux.html"
     disk_report_darwin: str = "disk_report_darwin.html"
+
+
+class APIRouteType(StrEnum):
+    """Types of API routes available.
+
+    >>> APIRouteType
+
+    """
+
+    get: str = "get"
+    post: str = "post"
+    monitor: str = "monitor"
diff --git a/pyninja/modules/models.py b/pyninja/modules/models.py
index d66df2e..f4c5686 100644
--- a/pyninja/modules/models.py
+++ b/pyninja/modules/models.py
@@ -8,6 +8,7 @@
 from concurrent.futures import ThreadPoolExecutor
 from typing import Any, Callable, Dict, List, Set, Tuple
 
+from fastapi.routing import APIRoute, APIWebSocketRoute
 from pyarchitecture.config import default_cpu_lib, default_disk_lib, default_gpu_lib
 from pydantic import BaseModel, Field, FilePath, PositiveInt, field_validator
 from pydantic_settings import BaseSettings
@@ -67,6 +68,23 @@ def complexity_checker(key: str, value: str, min_length: int) -> None:
     ), f"{key!r} must contain at least one special character"
 
 
+class RoutingHandler(BaseModel):
+    """Routing handler to update the API routes to the server.
+
+    >>> RoutingHandler
+
+    """
+
+    type: enums.APIRouteType
+    routes: List[APIRoute | APIWebSocketRoute]
+    enabled: bool = False
+
+    class Config:
+        """Configuration for routing handler."""
+
+        arbitrary_types_allowed = True
+
+
 class ServiceStatus(BaseModel):
     """Object to load service status with a status code and description.
 
